diff --git a/services/serverbackup/src/stackit/serverbackup/__init__.py b/services/serverbackup/src/stackit/serverbackup/__init__.py index f94cde1c..ffca3dc3 100644 --- a/services/serverbackup/src/stackit/serverbackup/__init__.py +++ b/services/serverbackup/src/stackit/serverbackup/__init__.py @@ -36,6 +36,10 @@ # import models into sdk package from stackit.serverbackup.models.backup import Backup from stackit.serverbackup.models.backup_job import BackupJob +from stackit.serverbackup.models.backup_policy import BackupPolicy +from stackit.serverbackup.models.backup_policy_backup_properties import ( + BackupPolicyBackupProperties, +) from stackit.serverbackup.models.backup_properties import BackupProperties from stackit.serverbackup.models.backup_schedule import BackupSchedule from stackit.serverbackup.models.backup_volume_backups_inner import ( @@ -49,6 +53,9 @@ from stackit.serverbackup.models.enable_service_resource_payload import ( EnableServiceResourcePayload, ) +from stackit.serverbackup.models.get_backup_policies_response import ( + GetBackupPoliciesResponse, +) from stackit.serverbackup.models.get_backup_schedules_response import ( GetBackupSchedulesResponse, ) diff --git a/services/serverbackup/src/stackit/serverbackup/api/default_api.py b/services/serverbackup/src/stackit/serverbackup/api/default_api.py index 62745c30..a6a69279 100644 --- a/services/serverbackup/src/stackit/serverbackup/api/default_api.py +++ b/services/serverbackup/src/stackit/serverbackup/api/default_api.py @@ -32,6 +32,9 @@ from stackit.serverbackup.models.enable_service_resource_payload import ( EnableServiceResourcePayload, ) +from stackit.serverbackup.models.get_backup_policies_response import ( + GetBackupPoliciesResponse, +) from stackit.serverbackup.models.get_backup_schedules_response import ( GetBackupSchedulesResponse, ) @@ -2888,6 +2891,235 @@ def _get_backup_schedule_serialize( _request_auth=_request_auth, ) + @validate_call + def list_backup_policies( + self, + project_id: Annotated[StrictStr, Field(description="project id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GetBackupPoliciesResponse: + """get list of backup policies + + + :param project_id: project id (required) + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 docstring might be too long + + _param = self._list_backup_policies_serialize( + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetBackupPoliciesResponse", + "400": None, + "404": None, + } + response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def list_backup_policies_with_http_info( + self, + project_id: Annotated[StrictStr, Field(description="project id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GetBackupPoliciesResponse]: + """get list of backup policies + + + :param project_id: project id (required) + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 docstring might be too long + + _param = self._list_backup_policies_serialize( + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetBackupPoliciesResponse", + "400": None, + "404": None, + } + response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def list_backup_policies_without_preload_content( + self, + project_id: Annotated[StrictStr, Field(description="project id")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """get list of backup policies + + + :param project_id: project id (required) + :type project_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 docstring might be too long + + _param = self._list_backup_policies_serialize( + project_id=project_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "GetBackupPoliciesResponse", + "400": None, + "404": None, + } + response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) + return response_data.response + + def _list_backup_policies_serialize( + self, + project_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if project_id is not None: + _path_params["projectId"] = project_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept(["application/json"]) + + # authentication setting + _auth_settings: List[str] = [] + + return self.api_client.param_serialize( + method="GET", + resource_path="/v1/projects/{projectId}/backup-policies", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) + @validate_call def list_backup_schedules( self, diff --git a/services/serverbackup/src/stackit/serverbackup/models/__init__.py b/services/serverbackup/src/stackit/serverbackup/models/__init__.py index b86bb1bf..1eef7c73 100644 --- a/services/serverbackup/src/stackit/serverbackup/models/__init__.py +++ b/services/serverbackup/src/stackit/serverbackup/models/__init__.py @@ -17,6 +17,10 @@ # import models into model package from stackit.serverbackup.models.backup import Backup from stackit.serverbackup.models.backup_job import BackupJob +from stackit.serverbackup.models.backup_policy import BackupPolicy +from stackit.serverbackup.models.backup_policy_backup_properties import ( + BackupPolicyBackupProperties, +) from stackit.serverbackup.models.backup_properties import BackupProperties from stackit.serverbackup.models.backup_schedule import BackupSchedule from stackit.serverbackup.models.backup_volume_backups_inner import ( @@ -30,6 +34,9 @@ from stackit.serverbackup.models.enable_service_resource_payload import ( EnableServiceResourcePayload, ) +from stackit.serverbackup.models.get_backup_policies_response import ( + GetBackupPoliciesResponse, +) from stackit.serverbackup.models.get_backup_schedules_response import ( GetBackupSchedulesResponse, ) diff --git a/services/serverbackup/src/stackit/serverbackup/models/backup_policy.py b/services/serverbackup/src/stackit/serverbackup/models/backup_policy.py new file mode 100644 index 00000000..96e96aa7 --- /dev/null +++ b/services/serverbackup/src/stackit/serverbackup/models/backup_policy.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + STACKIT Server Backup Management API + + API endpoints for Server Backup Operations on STACKIT Servers. + + The version of the OpenAPI document: 1.0 + Contact: support@stackit.de + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 docstring might be too long + +from __future__ import annotations + +import json +import pprint +from typing import Any, ClassVar, Dict, List, Optional, Set + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing_extensions import Self + +from stackit.serverbackup.models.backup_policy_backup_properties import ( + BackupPolicyBackupProperties, +) + + +class BackupPolicy(BaseModel): + """ + BackupPolicy + """ + + backup_properties: Optional[BackupPolicyBackupProperties] = Field(default=None, alias="backupProperties") + default: Optional[StrictBool] = None + description: Optional[StrictStr] = None + enabled: Optional[StrictBool] = None + id: Optional[StrictStr] = None + name: Optional[StrictStr] = None + rrule: Optional[StrictStr] = None + __properties: ClassVar[List[str]] = ["backupProperties", "default", "description", "enabled", "id", "name", "rrule"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of BackupPolicy from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of backup_properties + if self.backup_properties: + _dict["backupProperties"] = self.backup_properties.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of BackupPolicy from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "backupProperties": ( + BackupPolicyBackupProperties.from_dict(obj["backupProperties"]) + if obj.get("backupProperties") is not None + else None + ), + "default": obj.get("default"), + "description": obj.get("description"), + "enabled": obj.get("enabled"), + "id": obj.get("id"), + "name": obj.get("name"), + "rrule": obj.get("rrule"), + } + ) + return _obj diff --git a/services/serverbackup/src/stackit/serverbackup/models/backup_policy_backup_properties.py b/services/serverbackup/src/stackit/serverbackup/models/backup_policy_backup_properties.py new file mode 100644 index 00000000..4dc89a73 --- /dev/null +++ b/services/serverbackup/src/stackit/serverbackup/models/backup_policy_backup_properties.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + STACKIT Server Backup Management API + + API endpoints for Server Backup Operations on STACKIT Servers. + + The version of the OpenAPI document: 1.0 + Contact: support@stackit.de + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 docstring might be too long + +from __future__ import annotations + +import json +import pprint +from typing import Any, ClassVar, Dict, List, Optional, Set + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing_extensions import Self + + +class BackupPolicyBackupProperties(BaseModel): + """ + BackupPolicyBackupProperties + """ + + name: Optional[StrictStr] = None + retention_period: Optional[StrictInt] = Field(default=None, alias="retentionPeriod") + __properties: ClassVar[List[str]] = ["name", "retentionPeriod"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of BackupPolicyBackupProperties from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of BackupPolicyBackupProperties from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({"name": obj.get("name"), "retentionPeriod": obj.get("retentionPeriod")}) + return _obj diff --git a/services/serverbackup/src/stackit/serverbackup/models/get_backup_policies_response.py b/services/serverbackup/src/stackit/serverbackup/models/get_backup_policies_response.py new file mode 100644 index 00000000..cce1cee1 --- /dev/null +++ b/services/serverbackup/src/stackit/serverbackup/models/get_backup_policies_response.py @@ -0,0 +1,97 @@ +# coding: utf-8 + +""" + STACKIT Server Backup Management API + + API endpoints for Server Backup Operations on STACKIT Servers. + + The version of the OpenAPI document: 1.0 + Contact: support@stackit.de + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 docstring might be too long + +from __future__ import annotations + +import json +import pprint +from typing import Any, ClassVar, Dict, List, Optional, Set + +from pydantic import BaseModel, ConfigDict +from typing_extensions import Self + +from stackit.serverbackup.models.backup_policy import BackupPolicy + + +class GetBackupPoliciesResponse(BaseModel): + """ + GetBackupPoliciesResponse + """ + + items: Optional[List[BackupPolicy]] = None + __properties: ClassVar[List[str]] = ["items"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of GetBackupPoliciesResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in items (list) + _items = [] + if self.items: + for _item in self.items: + if _item: + _items.append(_item.to_dict()) + _dict["items"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of GetBackupPoliciesResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "items": ( + [BackupPolicy.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None + ) + } + ) + return _obj