mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2026-06-20 07:25:31 +00:00
147 lines
7.6 KiB
Python
147 lines
7.6 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
Tests API
|
|
|
|
This API supports listing, creating, editing, and deleting Cloud and Enterprise Agent (CEA) based 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.test_links import TestLinks
|
|
from typing import Optional, Set
|
|
from typing_extensions import Self
|
|
|
|
class BgpTestRequest(BaseModel):
|
|
"""
|
|
BgpTestRequest
|
|
""" # noqa: E501
|
|
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.", 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[StrictStr]] = Field(default=None, description="Contains list of test label IDs (get `labelId` from `/labels` endpoint)")
|
|
shared_with_accounts: Optional[List[StrictStr]] = Field(default=None, description="Contains list of account group IDs. Test is shared with the listed account groups (get `aid` from `/account-groups` endpoint)", alias="sharedWithAccounts")
|
|
enabled: Optional[StrictBool] = Field(default=True, description="Test is enabled.")
|
|
monitors: Optional[List[StrictStr]] = Field(default=None, description="Contains list of BGP monitor IDs (get `monitorId` from `/monitors` endpoint)")
|
|
include_covered_prefixes: Optional[StrictBool] = Field(default=None, description="Indicate if queries for subprefixes detected under this prefix should included.", alias="includeCoveredPrefixes")
|
|
use_public_bgp: Optional[StrictBool] = Field(default=True, description="Indicate if all available public BGP monitors should be used, when ommited defaults to `bgpMeasurements` value.", alias="usePublicBgp")
|
|
alerts_enabled: Optional[StrictBool] = Field(default=None, description="Indicates if alerts are enabled.", alias="alertsEnabled")
|
|
alert_rules: Optional[List[StrictStr]] = Field(default=None, description="List of alert rules IDs to apply to the test (get `ruleId` from `/alerts/rules` endpoint. If `alertsEnabled` is set to `true` and `alertRules` is not included on test creation or update, applicable user default alert rules will be used)", alias="alertRules")
|
|
prefix: StrictStr = Field(description="a.b.c.d is a network address, with the prefix length defined as e. Prefixes can be any length from 8 to 24.")
|
|
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "enabled", "monitors", "includeCoveredPrefixes", "usePublicBgp", "alertsEnabled", "alertRules", "prefix"]
|
|
|
|
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 BgpTestRequest 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.
|
|
"""
|
|
excluded_fields: Set[str] = set([
|
|
"created_by",
|
|
"created_date",
|
|
"live_share",
|
|
"modified_by",
|
|
"modified_date",
|
|
"saved_event",
|
|
"test_id",
|
|
"type",
|
|
])
|
|
|
|
_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()
|
|
return _dict
|
|
|
|
@classmethod
|
|
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
"""Create an instance of BgpTestRequest from a dict"""
|
|
if obj is None:
|
|
return None
|
|
|
|
if not isinstance(obj, dict):
|
|
return cls.model_validate(obj)
|
|
|
|
_obj = cls.model_validate({
|
|
"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": obj.get("labels"),
|
|
"sharedWithAccounts": obj.get("sharedWithAccounts"),
|
|
"enabled": obj.get("enabled") if obj.get("enabled") is not None else True,
|
|
"monitors": obj.get("monitors"),
|
|
"includeCoveredPrefixes": obj.get("includeCoveredPrefixes"),
|
|
"usePublicBgp": obj.get("usePublicBgp") if obj.get("usePublicBgp") is not None else True,
|
|
"alertsEnabled": obj.get("alertsEnabled"),
|
|
"alertRules": obj.get("alertRules"),
|
|
"prefix": obj.get("prefix")
|
|
})
|
|
return _obj
|
|
|
|
|