# coding: utf-8

"""
    Endpoint Test Results API

    Retrieve results for scheduled and dynamic tests on endpoint agents.

    Generated by OpenAPI Generator (https://openapi-generator.tech)

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


from __future__ import annotations
import pprint
import re  # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from thousandeyes_sdk.endpoint_test_results.models.endpoint_test_result_protocol import EndpointTestResultProtocol
from thousandeyes_sdk.endpoint_test_results.models.tcp_path_trace_mode_response import TcpPathTraceModeResponse
from thousandeyes_sdk.endpoint_test_results.models.udp_path_trace_mode_response import UdpPathTraceModeResponse
from typing import Optional, Set
from typing_extensions import Self

class EndpointPathTrace(BaseModel):
    """
    EndpointPathTrace
    """ # noqa: E501
    ip_address: Optional[StrictStr] = Field(default=None, description="IP address of the hop destination.", alias="ipAddress")
    number_of_hops: Optional[StrictInt] = Field(default=None, description="Number of hops for path trace to destination.", alias="numberOfHops")
    protocol: Optional[EndpointTestResultProtocol] = None
    tcp_path_trace_mode: Optional[TcpPathTraceModeResponse] = Field(default=None, alias="tcpPathTraceMode")
    udp_path_trace_mode: Optional[UdpPathTraceModeResponse] = Field(default=None, alias="udpPathTraceMode")
    path_id: Optional[StrictStr] = Field(default=None, description="Unique ID of path trace.", alias="pathId")
    response_time: Optional[StrictInt] = Field(default=None, description="RTT of the path trace to the destination in milliseconds.", alias="responseTime")
    __properties: ClassVar[List[str]] = ["ipAddress", "numberOfHops", "protocol", "tcpPathTraceMode", "udpPathTraceMode", "pathId", "responseTime"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
        extra="allow",
    )


    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 self.model_dump_json(by_alias=True, exclude_unset=True, exclude_none=True)

    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of EndpointPathTrace 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.
        * OpenAPI `readOnly` fields are excluded.
        * OpenAPI `readOnly` fields are excluded.
        * OpenAPI `readOnly` fields are excluded.
        """
        excluded_fields: Set[str] = set([
            "ip_address",
            "number_of_hops",
            "path_id",
            "response_time",
        ])

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

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

        _obj = cls.model_validate({
            "ipAddress": obj.get("ipAddress"),
            "numberOfHops": obj.get("numberOfHops"),
            "protocol": obj.get("protocol"),
            "tcpPathTraceMode": obj.get("tcpPathTraceMode"),
            "udpPathTraceMode": obj.get("udpPathTraceMode"),
            "pathId": obj.get("pathId"),
            "responseTime": obj.get("responseTime")
        })
        return _obj


