mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2026-06-19 17:36:51 +00:00
184 lines
8.8 KiB
Python
184 lines
8.8 KiB
Python
# coding: utf-8
|
||
|
||
"""
|
||
Agents API
|
||
|
||
## Overview Manage Cloud and Enterprise Agents available to your account in ThousandEyes.
|
||
|
||
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, StrictBool, StrictStr, field_validator
|
||
from typing import Any, ClassVar, Dict, List, Optional
|
||
from typing_extensions import Annotated
|
||
from thousandeyes_sdk.agents.models.agent_label import AgentLabel
|
||
from thousandeyes_sdk.agents.models.agent_tag import AgentTag
|
||
from thousandeyes_sdk.agents.models.coordinates import Coordinates
|
||
from thousandeyes_sdk.agents.models.self_links import SelfLinks
|
||
from thousandeyes_sdk.agents.models.simple_agent_all_of_network_provider_info import SimpleAgentAllOfNetworkProviderInfo
|
||
from thousandeyes_sdk.agents.models.simple_test import SimpleTest
|
||
from typing import Optional, Set
|
||
from typing_extensions import Self
|
||
|
||
class CloudAgentDetail(BaseModel):
|
||
"""
|
||
CloudAgentDetail
|
||
""" # noqa: E501
|
||
ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of private IP addresses.", alias="ipAddresses")
|
||
public_ip_addresses: Optional[List[StrictStr]] = Field(default=None, description="Array of public IP addresses.", alias="publicIpAddresses")
|
||
network: Optional[StrictStr] = Field(default=None, description="Network (including ASN) of agent’s public IP.")
|
||
agent_id: Optional[StrictStr] = Field(default=None, description="Unique ID of the agent.", alias="agentId")
|
||
agent_name: Optional[StrictStr] = Field(default=None, description="Name of the agent.", alias="agentName")
|
||
location: Optional[StrictStr] = Field(default=None, description="Location of the agent.")
|
||
country_id: Optional[StrictStr] = Field(default=None, description="2-digit ISO country code", alias="countryId")
|
||
coordinates: Optional[Coordinates] = None
|
||
network_provider_info: Optional[SimpleAgentAllOfNetworkProviderInfo] = Field(default=None, alias="networkProviderInfo")
|
||
enabled: Optional[StrictBool] = Field(default=None, description="Flag indicating if the agent is enabled.")
|
||
verify_ssl_certificates: Optional[StrictBool] = Field(default=None, description="Flag indicating if has normal SSL operations or if instead it's set to ignore SSL errors on browserbot-based tests.", alias="verifySslCertificates")
|
||
prefix: Optional[StrictStr] = Field(default=None, description="Prefix containing agents public IP address.")
|
||
agent_type: Annotated[str, Field(strict=True)] = Field(description="Cloud agent type.", alias="agentType")
|
||
tests: Optional[List[SimpleTest]] = Field(default=None, description="List of tests. See `/tests` for more information.")
|
||
labels: Optional[List[AgentLabel]] = Field(default=None, description="List of labels - see `/labels` for more information.")
|
||
tags: Optional[List[AgentTag]] = Field(default=None, description="List of tags. See `/tags` for more information.")
|
||
links: Optional[SelfLinks] = Field(default=None, alias="_links")
|
||
__properties: ClassVar[List[str]] = ["ipAddresses", "publicIpAddresses", "network", "agentId", "agentName", "location", "countryId", "coordinates", "networkProviderInfo", "enabled", "verifySslCertificates", "prefix", "agentType", "tests", "labels", "tags", "_links"]
|
||
|
||
@field_validator('agent_type')
|
||
def agent_type_validate_regular_expression(cls, value):
|
||
"""Validates the regular expression"""
|
||
if not re.match(r"^cloud$", value):
|
||
raise ValueError(r"must validate the regular expression /^cloud$/")
|
||
return value
|
||
|
||
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 CloudAgentDetail 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.
|
||
* OpenAPI `readOnly` fields are excluded.
|
||
* OpenAPI `readOnly` fields are excluded.
|
||
* 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_addresses",
|
||
"public_ip_addresses",
|
||
"network",
|
||
"agent_id",
|
||
"location",
|
||
"country_id",
|
||
"verify_ssl_certificates",
|
||
"prefix",
|
||
"labels",
|
||
"tags",
|
||
])
|
||
|
||
_dict = self.model_dump(
|
||
by_alias=True,
|
||
exclude=excluded_fields,
|
||
exclude_none=True,
|
||
)
|
||
# override the default output from pydantic by calling `to_dict()` of coordinates
|
||
if self.coordinates:
|
||
_dict['coordinates'] = self.coordinates.to_dict()
|
||
# override the default output from pydantic by calling `to_dict()` of network_provider_info
|
||
if self.network_provider_info:
|
||
_dict['networkProviderInfo'] = self.network_provider_info.to_dict()
|
||
# override the default output from pydantic by calling `to_dict()` of each item in tests (list)
|
||
_items = []
|
||
if self.tests:
|
||
for _item in self.tests:
|
||
if _item:
|
||
_items.append(_item.to_dict())
|
||
_dict['tests'] = _items
|
||
# override the default output from pydantic by calling `to_dict()` of each item in labels (list)
|
||
_items = []
|
||
if self.labels:
|
||
for _item in self.labels:
|
||
if _item:
|
||
_items.append(_item.to_dict())
|
||
_dict['labels'] = _items
|
||
# override the default output from pydantic by calling `to_dict()` of each item in tags (list)
|
||
_items = []
|
||
if self.tags:
|
||
for _item in self.tags:
|
||
if _item:
|
||
_items.append(_item.to_dict())
|
||
_dict['tags'] = _items
|
||
# override the default output from pydantic by calling `to_dict()` of links
|
||
if self.links:
|
||
_dict['_links'] = self.links.to_dict()
|
||
return _dict
|
||
|
||
@classmethod
|
||
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
||
"""Create an instance of CloudAgentDetail from a dict"""
|
||
if obj is None:
|
||
return None
|
||
|
||
if not isinstance(obj, dict):
|
||
return cls.model_validate(obj)
|
||
|
||
_obj = cls.model_validate({
|
||
"ipAddresses": obj.get("ipAddresses"),
|
||
"publicIpAddresses": obj.get("publicIpAddresses"),
|
||
"network": obj.get("network"),
|
||
"agentId": obj.get("agentId"),
|
||
"agentName": obj.get("agentName"),
|
||
"location": obj.get("location"),
|
||
"countryId": obj.get("countryId"),
|
||
"coordinates": Coordinates.from_dict(obj["coordinates"]) if obj.get("coordinates") is not None else None,
|
||
"networkProviderInfo": SimpleAgentAllOfNetworkProviderInfo.from_dict(obj["networkProviderInfo"]) if obj.get("networkProviderInfo") is not None else None,
|
||
"enabled": obj.get("enabled"),
|
||
"verifySslCertificates": obj.get("verifySslCertificates"),
|
||
"prefix": obj.get("prefix"),
|
||
"agentType": obj.get("agentType"),
|
||
"tests": [SimpleTest.from_dict(_item) for _item in obj["tests"]] if obj.get("tests") is not None else None,
|
||
"labels": [AgentLabel.from_dict(_item) for _item in obj["labels"]] if obj.get("labels") is not None else None,
|
||
"tags": [AgentTag.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None,
|
||
"_links": SelfLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None
|
||
})
|
||
return _obj
|
||
|
||
|