snapshot_policy.py

# coding: utf-8

"""
    STACKIT File Storage (SFS)

    API used to create and manage NFS Shares.

    The version of the OpenAPI document: 1.0.0
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501

from __future__ import annotations

import json
import pprint
import re  # noqa: F401
from datetime import datetime
from typing import Any, ClassVar, Dict, List, Optional, Set

from pydantic import (
    BaseModel,
    ConfigDict,
    Field,
    StrictBool,
    StrictStr,
    field_validator,
)
from typing_extensions import Self

from stackit.sfs.models.snapshot_policy_schedule import SnapshotPolicySchedule
from stackit.sfs.models.snapshot_policy_snapshot_policy_schedule import (
    SnapshotPolicySnapshotPolicySchedule,
)


class SnapshotPolicy(BaseModel):
    """
    SnapshotPolicy
    """  # noqa: E501

    comment: Optional[StrictStr] = Field(default=None, description="Comment of the Snapshot Policy")
    created_at: Optional[datetime] = Field(default=None, description="created at timestamp", alias="createdAt")
    enabled: Optional[StrictBool] = Field(default=None, description="Wether the Snapshot Policy is enabled")
    id: Optional[StrictStr] = Field(default=None, description="ID of the Snapshot Policy")
    name: Optional[StrictStr] = Field(default=None, description="Name of the Snapshot Policy")
    schedules: Optional[List[SnapshotPolicySchedule]] = Field(
        default=None, description="(deprecated) associated schedules"
    )
    snapshot_schedules: Optional[List[SnapshotPolicySnapshotPolicySchedule]] = Field(
        default=None, description="associated schedules", alias="snapshotSchedules"
    )
    __properties: ClassVar[List[str]] = [
        "comment",
        "createdAt",
        "enabled",
        "id",
        "name",
        "schedules",
        "snapshotSchedules",
    ]

    @field_validator("created_at", mode="before")
    def created_at_change_year_zero_to_one(cls, value):
        """Workaround which prevents year 0 issue"""
        if isinstance(value, str):
            # Check for year "0000" at the beginning of the string
            # This assumes common date formats like YYYY-MM-DDTHH:MM:SS+00:00 or YYYY-MM-DDTHH:MM:SSZ
            if value.startswith("0000-01-01T") and re.match(
                r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\+\d{2}:\d{2}|Z)$", value
            ):
                # Workaround: Replace "0000" with "0001"
                return "0001" + value[4:]  # Take "0001" and append the rest of the string
        return value

    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 SnapshotPolicy 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 schedules (list)
        _items = []
        if self.schedules:
            for _item_schedules in self.schedules:
                if _item_schedules:
                    _items.append(_item_schedules.to_dict())
            _dict["schedules"] = _items
        # override the default output from pydantic by calling `to_dict()` of each item in snapshot_schedules (list)
        _items = []
        if self.snapshot_schedules:
            for _item_snapshot_schedules in self.snapshot_schedules:
                if _item_snapshot_schedules:
                    _items.append(_item_snapshot_schedules.to_dict())
            _dict["snapshotSchedules"] = _items
        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of SnapshotPolicy from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate(
            {
                "comment": obj.get("comment"),
                "createdAt": obj.get("createdAt"),
                "enabled": obj.get("enabled"),
                "id": obj.get("id"),
                "name": obj.get("name"),
                "schedules": (
                    [SnapshotPolicySchedule.from_dict(_item) for _item in obj["schedules"]]
                    if obj.get("schedules") is not None
                    else None
                ),
                "snapshotSchedules": (
                    [SnapshotPolicySnapshotPolicySchedule.from_dict(_item) for _item in obj["snapshotSchedules"]]
                    if obj.get("snapshotSchedules") is not None
                    else None
                ),
            }
        )
        return _obj