instance.py

# coding: utf-8

"""
    STACKIT Edge Cloud API

    This API provides endpoints for managing STACKIT Edge Cloud instances.

    The version of the OpenAPI document: 1beta1
    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 uuid import UUID

from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
from pydantic_core import to_jsonable_python
from typing_extensions import Annotated, Self

from stackit.edge.models.acl import Acl


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

    acl: Optional[Acl] = None
    created: datetime = Field(description="The date and time the creation of the instance was triggered.")
    description: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(
        default=None, description="A user chosen description to distinguish multiple instances."
    )
    display_name: Annotated[str, Field(strict=True, max_length=8)] = Field(
        description="The displayed name of the instance.", alias="displayName"
    )
    frontend_url: StrictStr = Field(description="URL to the Management UI of the Instance.", alias="frontendUrl")
    id: Annotated[str, Field(strict=True, max_length=16)] = Field(
        description="A auto generated unique id which identifies the instance."
    )
    plan_id: UUID = Field(description="Service Plan configures the size of the Instance.", alias="planId")
    status: StrictStr = Field(description="The current status of the instance.")
    __properties: ClassVar[List[str]] = [
        "acl",
        "created",
        "description",
        "displayName",
        "frontendUrl",
        "id",
        "planId",
        "status",
    ]

    @field_validator("created", mode="before")
    def created_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

    @field_validator("status")
    def status_validate_enum(cls, value):
        """Validates the enum"""
        if value not in set(["error", "reconciling", "active", "deleting"]):
            raise ValueError("must be one of enum values ('error', 'reconciling', 'active', 'deleting')")
        return value

    model_config = ConfigDict(
        validate_by_name=True,
        validate_by_alias=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"""
        return json.dumps(to_jsonable_python(self.to_dict()))

    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of Instance 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 acl
        if self.acl:
            _dict["acl"] = self.acl.to_dict()
        return _dict

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

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

        _obj = cls.model_validate(
            {
                "acl": Acl.from_dict(obj["acl"]) if obj.get("acl") is not None else None,
                "created": obj.get("created"),
                "description": obj.get("description"),
                "displayName": obj.get("displayName"),
                "frontendUrl": obj.get("frontendUrl"),
                "id": obj.get("id"),
                "planId": obj.get("planId"),
                "status": obj.get("status"),
            }
        )
        return _obj