mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2026-06-20 07:25:31 +00:00
192 lines
10 KiB
Python
192 lines
10 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
Tests API
|
|
|
|
**Note:** The Page Load Tests, API Tests, and Web Transaction Tests APIs are not available for ThousandEyes for Government instance. This API allows you to list, create, edit, and delete Network and Application Synthetics tests.
|
|
|
|
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 datetime import datetime
|
|
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
|
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
from thousandeyes_sdk.tests.models.alert_rule import AlertRule
|
|
from thousandeyes_sdk.tests.models.dns_query_class import DnsQueryClass
|
|
from thousandeyes_sdk.tests.models.shared_with_account import SharedWithAccount
|
|
from thousandeyes_sdk.tests.models.test_dns_transport_protocol import TestDnsTransportProtocol
|
|
from thousandeyes_sdk.tests.models.test_interval import TestInterval
|
|
from thousandeyes_sdk.tests.models.test_label import TestLabel
|
|
from thousandeyes_sdk.tests.models.test_links import TestLinks
|
|
from thousandeyes_sdk.tests.models.test_tag import TestTag
|
|
from typing import Optional, Set
|
|
from typing_extensions import Self
|
|
|
|
class DnsTraceTest(BaseModel):
|
|
"""
|
|
DnsTraceTest
|
|
""" # noqa: E501
|
|
interval: TestInterval
|
|
alerts_enabled: Optional[StrictBool] = Field(default=None, description="Indicates if alerts are enabled.", alias="alertsEnabled")
|
|
enabled: Optional[StrictBool] = Field(default=True, description="Test is enabled.")
|
|
alert_rules: Optional[List[AlertRule]] = Field(default=None, description="Contains list of enabled alert rule objects.", alias="alertRules")
|
|
created_by: Optional[StrictStr] = Field(default=None, description="User that created the test.", alias="createdBy")
|
|
created_date: Optional[datetime] = Field(default=None, description="UTC created date (ISO date-time format).", alias="createdDate")
|
|
description: Optional[StrictStr] = Field(default=None, description="A description of the test.")
|
|
live_share: Optional[StrictBool] = Field(default=None, description="Indicates if the test is shared with the account group.", alias="liveShare")
|
|
modified_by: Optional[StrictStr] = Field(default=None, description="User that modified the test.", alias="modifiedBy")
|
|
modified_date: Optional[datetime] = Field(default=None, description="UTC last modification date (ISO date-time format).", alias="modifiedDate")
|
|
saved_event: Optional[StrictBool] = Field(default=None, description="Indicates if the test is a saved event. **Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect API. ", alias="savedEvent")
|
|
test_id: Optional[StrictStr] = Field(default=None, description="Each test is assigned an unique ID; this is used to access test information and results from other endpoints.", alias="testId")
|
|
test_name: Optional[StrictStr] = Field(default=None, description="The name of the test. Test name must be unique.", alias="testName")
|
|
type: Optional[StrictStr] = None
|
|
links: Optional[TestLinks] = Field(default=None, alias="_links")
|
|
labels: Optional[List[TestLabel]] = Field(default=None, description="Labels to which the test is assigned. This field is not returned for Instant Tests.")
|
|
tags: Optional[List[TestTag]] = Field(default=None, description="Tags assigned to the test. Returned only when `expand=tag` is specified. This field is not returned for Instant Tests. For more information, see `/tags`.")
|
|
shared_with_accounts: Optional[List[SharedWithAccount]] = Field(default=None, alias="sharedWithAccounts")
|
|
dns_transport_protocol: Optional[TestDnsTransportProtocol] = Field(default=None, alias="dnsTransportProtocol")
|
|
domain: StrictStr = Field(description="The target record for the test, with the record type suffixed. If no record type is specified, the test defaults to an ANY record.")
|
|
dns_query_class: Optional[DnsQueryClass] = Field(default=None, alias="dnsQueryClass")
|
|
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
|
__properties: ClassVar[List[str]] = ["interval", "alertsEnabled", "enabled", "alertRules", "createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "tags", "sharedWithAccounts", "dnsTransportProtocol", "domain", "dnsQueryClass", "randomizedStartTime"]
|
|
|
|
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 DnsTraceTest 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.
|
|
* OpenAPI `readOnly` fields are excluded.
|
|
"""
|
|
excluded_fields: Set[str] = set([
|
|
"created_by",
|
|
"created_date",
|
|
"live_share",
|
|
"modified_by",
|
|
"modified_date",
|
|
"saved_event",
|
|
"test_id",
|
|
"type",
|
|
"labels",
|
|
"tags",
|
|
"shared_with_accounts",
|
|
])
|
|
|
|
_dict = self.model_dump(
|
|
by_alias=True,
|
|
exclude=excluded_fields,
|
|
exclude_none=True,
|
|
)
|
|
# override the default output from pydantic by calling `to_dict()` of each item in alert_rules (list)
|
|
_items = []
|
|
if self.alert_rules:
|
|
for _item in self.alert_rules:
|
|
if _item:
|
|
_items.append(_item.to_dict())
|
|
_dict['alertRules'] = _items
|
|
# override the default output from pydantic by calling `to_dict()` of links
|
|
if self.links:
|
|
_dict['_links'] = self.links.to_dict()
|
|
# 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 each item in shared_with_accounts (list)
|
|
_items = []
|
|
if self.shared_with_accounts:
|
|
for _item in self.shared_with_accounts:
|
|
if _item:
|
|
_items.append(_item.to_dict())
|
|
_dict['sharedWithAccounts'] = _items
|
|
return _dict
|
|
|
|
@classmethod
|
|
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
"""Create an instance of DnsTraceTest from a dict"""
|
|
if obj is None:
|
|
return None
|
|
|
|
if not isinstance(obj, dict):
|
|
return cls.model_validate(obj)
|
|
|
|
_obj = cls.model_validate({
|
|
"interval": obj.get("interval"),
|
|
"alertsEnabled": obj.get("alertsEnabled"),
|
|
"enabled": obj.get("enabled") if obj.get("enabled") is not None else True,
|
|
"alertRules": [AlertRule.from_dict(_item) for _item in obj["alertRules"]] if obj.get("alertRules") is not None else None,
|
|
"createdBy": obj.get("createdBy"),
|
|
"createdDate": obj.get("createdDate"),
|
|
"description": obj.get("description"),
|
|
"liveShare": obj.get("liveShare"),
|
|
"modifiedBy": obj.get("modifiedBy"),
|
|
"modifiedDate": obj.get("modifiedDate"),
|
|
"savedEvent": obj.get("savedEvent"),
|
|
"testId": obj.get("testId"),
|
|
"testName": obj.get("testName"),
|
|
"type": obj.get("type"),
|
|
"_links": TestLinks.from_dict(obj["_links"]) if obj.get("_links") is not None else None,
|
|
"labels": [TestLabel.from_dict(_item) for _item in obj["labels"]] if obj.get("labels") is not None else None,
|
|
"tags": [TestTag.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None,
|
|
"sharedWithAccounts": [SharedWithAccount.from_dict(_item) for _item in obj["sharedWithAccounts"]] if obj.get("sharedWithAccounts") is not None else None,
|
|
"dnsTransportProtocol": obj.get("dnsTransportProtocol"),
|
|
"domain": obj.get("domain"),
|
|
"dnsQueryClass": obj.get("dnsQueryClass"),
|
|
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False
|
|
})
|
|
return _obj
|
|
|
|
|