bgp_gateway_config.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 pydantic import BaseModel, ConfigDict, Field
from pydantic_core import to_jsonable_python
from typing_extensions import Annotated, Self


class BGPGatewayConfig(BaseModel):
    """
    BGP configuration effects all connections. (only for routingMode=BGP_ROUTE_BASED)
    """  # noqa: E501

    local_asn: Annotated[int, Field(le=4294967294, strict=True, ge=64512)] = Field(
        description="ASN for private use (reserved by IANA), both 16Bit and 32Bit ranges are valid (RFC 6996). ",
        alias="localAsn",
    )
    override_advertised_routes: Optional[Annotated[List[Annotated[str, Field(strict=True)]], Field(max_length=100)]] = (
        Field(
            default=None,
            description="A list of IPv4 Prefixes to advertise via BGP.  If omitted, the SNA network ranges will be advertised. ",
            alias="overrideAdvertisedRoutes",
        )
    )
    __properties: ClassVar[List[str]] = ["localAsn", "overrideAdvertisedRoutes"]

    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 BGPGatewayConfig 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,
        )
        return _dict

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

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

        _obj = cls.model_validate(
            {"localAsn": obj.get("localAsn"), "overrideAdvertisedRoutes": obj.get("overrideAdvertisedRoutes")}
        )
        return _obj