gateway_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
import re  # noqa: F401
from typing import Any, ClassVar, Dict, List, Optional, Set
from uuid import UUID

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

from stackit.vpn.models.bgp_gateway_config import BGPGatewayConfig
from stackit.vpn.models.create_vpn_gateway_payload_availability_zones import (
    CreateVPNGatewayPayloadAvailabilityZones,
)
from stackit.vpn.models.gateway_status import GatewayStatus
from stackit.vpn.models.routing_type import RoutingType


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

    availability_zones: CreateVPNGatewayPayloadAvailabilityZones = Field(alias="availabilityZones")
    bgp: Optional[BGPGatewayConfig] = None
    display_name: Annotated[str, Field(strict=True)] = Field(
        description="A user-friendly name for the VPN gateway.", alias="displayName"
    )
    labels: Optional[Dict[str, Annotated[str, Field(strict=True, max_length=63)]]] = Field(
        default=None,
        description="Map of custom labels. Key and values must be a string with max 63 chars, start/end with alphanumeric. The key of a label follows the same rules as the `LabelValue` except that it cannot be empty. ",
    )
    plan_id: StrictStr = Field(description="The service plan identifier.", alias="planId")
    routing_type: RoutingType = Field(alias="routingType")
    id: Optional[UUID] = Field(default=None, description="The server-generated UUID of the VPN gateway.")
    state: Optional[GatewayStatus] = None
    __properties: ClassVar[List[str]] = [
        "availabilityZones",
        "bgp",
        "displayName",
        "labels",
        "planId",
        "routingType",
        "id",
        "state",
    ]

    @field_validator("display_name")
    def display_name_validate_regular_expression(cls, value):
        """Validates the regular expression"""
        if not re.match(r"^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$", value):
            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$/")
        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 GatewayResponse 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.
        * OpenAPI `readOnly` fields are excluded.
        """
        excluded_fields: Set[str] = set(
            [
                "id",
            ]
        )

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of availability_zones
        if self.availability_zones:
            _dict["availabilityZones"] = self.availability_zones.to_dict()
        # override the default output from pydantic by calling `to_dict()` of bgp
        if self.bgp:
            _dict["bgp"] = self.bgp.to_dict()
        return _dict

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

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

        _obj = cls.model_validate(
            {
                "availabilityZones": (
                    CreateVPNGatewayPayloadAvailabilityZones.from_dict(obj["availabilityZones"])
                    if obj.get("availabilityZones") is not None
                    else None
                ),
                "bgp": BGPGatewayConfig.from_dict(obj["bgp"]) if obj.get("bgp") is not None else None,
                "displayName": obj.get("displayName"),
                "labels": obj.get("labels"),
                "planId": obj.get("planId"),
                "routingType": obj.get("routingType"),
                "id": obj.get("id"),
                "state": obj.get("state"),
            }
        )
        return _obj