gateway_status_response.py

# coding: utf-8

"""
    STACKIT VPN API

    Provision and manage STACKIT VPN gateways.  Use this API to establish secure, encrypted IPsec tunnels between your STACKIT Network Area (SNA) and external networks. The service supports the following routing architectures: - Policy-based IPsec - Static route-based IPsec - Dynamic BGP IPsec

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

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

from __future__ import annotations

import json
import pprint
from typing import Any, ClassVar, Dict, List, Optional, Set
from uuid import UUID

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

from stackit.vpn.models.connection_status_response import ConnectionStatusResponse
from stackit.vpn.models.gateway_status import GatewayStatus
from stackit.vpn.models.vpn_tunnels import VPNTunnels


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

    connections: Optional[List[ConnectionStatusResponse]] = None
    display_name: Optional[StrictStr] = Field(
        default=None, description="Name of the Gateway instance.", alias="displayName"
    )
    error_message: Optional[StrictStr] = Field(
        default=None,
        description="A descriptive message provided when the gateway is in an error state.",
        alias="errorMessage",
    )
    gateway_status: Optional[GatewayStatus] = Field(default=None, alias="gatewayStatus")
    id: Optional[UUID] = Field(default=None, description="UUID of the Gateway instance.")
    tunnels: Optional[List[VPNTunnels]] = None
    __properties: ClassVar[List[str]] = ["connections", "displayName", "errorMessage", "gatewayStatus", "id", "tunnels"]

    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 GatewayStatusResponse 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 connections (list)
        _items = []
        if self.connections:
            for _item_connections in self.connections:
                if _item_connections:
                    _items.append(_item_connections.to_dict())
            _dict["connections"] = _items
        # override the default output from pydantic by calling `to_dict()` of each item in tunnels (list)
        _items = []
        if self.tunnels:
            for _item_tunnels in self.tunnels:
                if _item_tunnels:
                    _items.append(_item_tunnels.to_dict())
            _dict["tunnels"] = _items
        return _dict

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

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

        _obj = cls.model_validate(
            {
                "connections": (
                    [ConnectionStatusResponse.from_dict(_item) for _item in obj["connections"]]
                    if obj.get("connections") is not None
                    else None
                ),
                "displayName": obj.get("displayName"),
                "errorMessage": obj.get("errorMessage"),
                "gatewayStatus": obj.get("gatewayStatus"),
                "id": obj.get("id"),
                "tunnels": (
                    [VPNTunnels.from_dict(_item) for _item in obj["tunnels"]]
                    if obj.get("tunnels") is not None
                    else None
                ),
            }
        )
        return _obj