create_rule_payload.py

# coding: utf-8

"""
STACKIT Unified Firewall API

API for managing and controlling the STACKIT Unified Firewall.

The version of the OpenAPI document: 1.0.0
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,
    StrictBool,
    StrictInt,
    StrictStr,
)
from pydantic_core import to_jsonable_python
from typing_extensions import Self


class CreateRulePayload(BaseModel):
    """
    The request body for creating a new security rule.
    """  # noqa: E501

    description: Optional[StrictStr] = Field(default=None, description="A description for the rule.")
    direction: Optional[StrictStr] = Field(
        default=None, description='The direction of the traffic, typically "ingress" or "egress".'
    )
    ether_type: Optional[StrictStr] = Field(
        default=None, description="Specifies the bound of the rule.", alias="etherType"
    )
    instance_id: StrictStr = Field(description="The ID of the product, similar to a project ID.", alias="instanceId")
    offset: Optional[StrictInt] = Field(default=None, description="Position in the list.")
    port_range: Optional[StrictStr] = Field(
        default=None, description="The Port range to which the rule applies.", alias="portRange"
    )
    product: StrictStr = Field(description="The source service (e.g., Load Balancer, Redis).")
    protocol: Optional[StrictStr] = Field(
        default=None, description='The network protocol (e.g., "TCP", "UDP", "ICMP").'
    )
    remote_security_group_id: Optional[StrictStr] = Field(
        default=None, description="The ID of the Group.", alias="remoteSecurityGroupId"
    )
    security_group_id: Optional[StrictStr] = Field(
        default=None, description="The ID of the Group.", alias="securityGroupId"
    )
    source_ip: StrictStr = Field(description="The IP (CIDR) to which the rule applies.", alias="sourceIP")
    stateful: Optional[StrictBool] = Field(
        default=None,
        description="Indicates whether the security group rule is stateful or stateless (used only for security groups, default value for them will be true).",
    )
    type: StrictStr = Field(description='The type of the rule (e.g., "ACL", "PublicIP", "SecurityRule").')
    __properties: ClassVar[List[str]] = [
        "description",
        "direction",
        "etherType",
        "instanceId",
        "offset",
        "portRange",
        "product",
        "protocol",
        "remoteSecurityGroupId",
        "securityGroupId",
        "sourceIP",
        "stateful",
        "type",
    ]

    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 CreateRulePayload 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 CreateRulePayload from a dict"""
        if obj is None:
            return None

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

        _obj = cls.model_validate(
            {
                "description": obj.get("description"),
                "direction": obj.get("direction"),
                "etherType": obj.get("etherType"),
                "instanceId": obj.get("instanceId"),
                "offset": obj.get("offset"),
                "portRange": obj.get("portRange"),
                "product": obj.get("product"),
                "protocol": obj.get("protocol"),
                "remoteSecurityGroupId": obj.get("remoteSecurityGroupId"),
                "securityGroupId": obj.get("securityGroupId"),
                "sourceIP": obj.get("sourceIP"),
                "stateful": obj.get("stateful"),
                "type": obj.get("type"),
            }
        )
        return _obj