thousandeyes-sdk-python/thousandeyes-sdk-endpoint-agents/src/thousandeyes_sdk/endpoint_agents/models/address_profile.py
Shahid Hussain Khan 9f18f0f6f2
[GitHub Bot] Generated python SDK (#42)
Co-authored-by: API Team <api-team@thousandeyes.com>
2024-08-11 09:57:09 +01:00

97 lines
3.6 KiB
Python

# coding: utf-8
"""
Endpoint Agents API
Manage ThousandEyes Endpoint Agents using this API. For more information about Endpoint Agents, see [Endpoint Agents](https://docs.thousandeyes.com/product-documentation/global-vantage-points/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_agents.models.address_type import AddressType
from typing import Optional, Set
from typing_extensions import Self
class AddressProfile(BaseModel):
"""
A description of the IPs assigned to this machine.
""" # noqa: E501
address_type: Optional[AddressType] = Field(default=None, alias="addressType")
ip_address: Optional[StrictStr] = Field(default=None, description="IP address of this interface in the network it's currently connected to.", alias="ipAddress")
prefix_length: Optional[StrictInt] = Field(default=None, description="The number of bits representing the network part of the `ipAddress`.", alias="prefixLength")
gateway: Optional[StrictStr] = Field(default=None, description="The default gateway for this interface.")
router_hardware_address: Optional[StrictStr] = Field(default=None, description="The router's MAC address resolved from an ARP request.", alias="routerHardwareAddress")
__properties: ClassVar[List[str]] = ["addressType", "ipAddress", "prefixLength", "gateway", "routerHardwareAddress"]
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 AddressProfile 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 AddressProfile from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate({
"addressType": obj.get("addressType"),
"ipAddress": obj.get("ipAddress"),
"prefixLength": obj.get("prefixLength"),
"gateway": obj.get("gateway"),
"routerHardwareAddress": obj.get("routerHardwareAddress")
})
return _obj