intake_response.py

# coding: utf-8

"""
    STACKIT Intake API

    This API provides endpoints for managing Intakes. 

    The version of the OpenAPI document: 1beta.3.6
    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, StrictInt, StrictStr, field_validator
from typing_extensions import Annotated, Self

from stackit.intake.models.intake_catalog import IntakeCatalog


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

    catalog: IntakeCatalog
    create_time: datetime = Field(description="The point in time the resource was created.")
    dead_letter_topic: Annotated[str, Field(strict=True, max_length=1024)] = Field(
        description="The topic where undelivered messages are published (Dead Letter Queue).", alias="deadLetterTopic"
    )
    description: Optional[Annotated[str, Field(strict=True, max_length=1024)]] = Field(
        default=None,
        description="The description is a longer text chosen by the user to provide more context for the resource.",
    )
    display_name: Annotated[str, Field(min_length=1, strict=True, max_length=32)] = Field(
        description="The display name is a short name chosen by the user to identify the resource.", alias="displayName"
    )
    failure_message: Optional[StrictStr] = Field(
        default=None, description="A human-readable description of the error, if the state is 'failed'."
    )
    id: StrictStr = Field(description="A auto generated unique id which identifies the resource.")
    intake_runner_id: StrictStr = Field(
        description="The unique id of the intake runner this intake is running on.", alias="intakeRunnerId"
    )
    labels: Optional[Dict[str, StrictStr]] = Field(
        default=None, description="Labels are a set of key-value pairs assigned to resources."
    )
    state: StrictStr = Field(description="The current state of the resource.")
    topic: Annotated[str, Field(strict=True, max_length=1024)] = Field(description="The topic to publish data to.")
    undelivered_message_count: Optional[StrictInt] = Field(
        default=None,
        description="Number of messages that failed delivery and were sent to the Dead Letter Queue.",
        alias="undeliveredMessageCount",
    )
    uri: Annotated[str, Field(strict=True, max_length=1024)] = Field(description="The URI for reaching the resource.")
    __properties: ClassVar[List[str]] = [
        "catalog",
        "create_time",
        "deadLetterTopic",
        "description",
        "displayName",
        "failure_message",
        "id",
        "intakeRunnerId",
        "labels",
        "state",
        "topic",
        "undeliveredMessageCount",
        "uri",
    ]

    @field_validator("create_time", mode="before")
    def create_time_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("state")
    def state_validate_enum(cls, value):
        """Validates the enum"""
        if value not in set(["reconciling", "active", "deleting", "failed"]):
            raise ValueError("must be one of enum values ('reconciling', 'active', 'deleting', 'failed')")
        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 IntakeResponse 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 catalog
        if self.catalog:
            _dict["catalog"] = self.catalog.to_dict()
        # set to None if labels (nullable) is None
        # and model_fields_set contains the field
        if self.labels is None and "labels" in self.model_fields_set:
            _dict["labels"] = None

        return _dict

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

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

        _obj = cls.model_validate(
            {
                "catalog": IntakeCatalog.from_dict(obj["catalog"]) if obj.get("catalog") is not None else None,
                "create_time": obj.get("create_time"),
                "deadLetterTopic": obj.get("deadLetterTopic"),
                "description": obj.get("description"),
                "displayName": obj.get("displayName"),
                "failure_message": obj.get("failure_message"),
                "id": obj.get("id"),
                "intakeRunnerId": obj.get("intakeRunnerId"),
                "labels": obj.get("labels"),
                "state": obj.get("state"),
                "topic": obj.get("topic"),
                "undeliveredMessageCount": obj.get("undeliveredMessageCount"),
                "uri": obj.get("uri"),
            }
        )
        return _obj