mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 14:36:50 +00:00
dcf0f54d56
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
148 lines
7.4 KiB
Python
148 lines
7.4 KiB
Python
# coding: utf-8
|
||
|
||
"""
|
||
Alerts API
|
||
|
||
You can manage the following alert functionalities on the ThousandEyes platform using the Alerts API: * **Alerts**: Retrieve alert details. Alerts are assigned to tests through alert rules. * **Alert Rules**: Conditions that you configure in order to highlight or be notified of events of interest in your ThousandEyes tests. When an alert rule’s conditions are met, the associated alert is triggered and the alert becomes active. It remains active until the alert is cleared. Alert rules are reusable across multiple tests.. * **Alert Suppression Windows**: Suppress alerts for tests during periods such as planned maintenance. Windows can be one-time events or recurring events to handle periodic occurrences such as monthly downtime for maintenance. For more information about the alerts, see [Alerts](https://docs.thousandeyes.com/product-documentation/alerts).
|
||
|
||
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.alerts.models.alert_test_type import AlertTestType
|
||
from thousandeyes_sdk.alerts.models.test_interval import TestInterval
|
||
from thousandeyes_sdk.alerts.models.test_links import TestLinks
|
||
from typing import Optional, Set
|
||
from typing_extensions import Self
|
||
|
||
class AlertSimpleTest(BaseModel):
|
||
"""
|
||
Each test includes additional fields depending on its `type`. Refer `/tests/{type}` endpoint to know the set of fields returned by a given `type`.
|
||
""" # noqa: E501
|
||
interval: Optional[TestInterval] = None
|
||
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.")
|
||
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[AlertTestType] = None
|
||
links: Optional[TestLinks] = Field(default=None, alias="_links")
|
||
additional_properties: Dict[str, Any] = {}
|
||
__properties: ClassVar[List[str]] = ["interval", "alertsEnabled", "enabled", "createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links"]
|
||
|
||
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 AlertSimpleTest 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.
|
||
* Fields in `self.additional_properties` are added to the output dict.
|
||
"""
|
||
excluded_fields: Set[str] = set([
|
||
"created_by",
|
||
"created_date",
|
||
"live_share",
|
||
"modified_by",
|
||
"modified_date",
|
||
"saved_event",
|
||
"test_id",
|
||
"additional_properties",
|
||
])
|
||
|
||
_dict = self.model_dump(
|
||
by_alias=True,
|
||
exclude=excluded_fields,
|
||
exclude_none=True,
|
||
)
|
||
# override the default output from pydantic by calling `to_dict()` of links
|
||
if self.links:
|
||
_dict['_links'] = self.links.to_dict()
|
||
# puts key-value pairs in additional_properties in the top level
|
||
if self.additional_properties is not None:
|
||
for _key, _value in self.additional_properties.items():
|
||
_dict[_key] = _value
|
||
|
||
return _dict
|
||
|
||
@classmethod
|
||
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
||
"""Create an instance of AlertSimpleTest 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,
|
||
"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
|
||
})
|
||
# store additional fields in additional_properties
|
||
for _key in obj.keys():
|
||
if _key not in cls.__properties:
|
||
_obj.additional_properties[_key] = obj.get(_key)
|
||
|
||
return _obj
|
||
|
||
|