mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-05 23:45:30 +00:00
[GitHub Bot] Generated python SDK (#85)
Some checks failed
Python CI / build (push) Has been cancelled
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
This commit is contained in:
parent
b1c34fef7c
commit
62bed5b328
@ -12,7 +12,7 @@ This API provides the following operations to manage your organization:
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ Manage all agents available to your account in ThousandEyes, including both Clou
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ README.md
|
||||
docs/Alert.md
|
||||
docs/AlertDetail.md
|
||||
docs/AlertDirection.md
|
||||
docs/AlertGroupType.md
|
||||
docs/AlertLinks.md
|
||||
docs/AlertMeta.md
|
||||
docs/AlertMetricDetail.md
|
||||
@ -69,6 +70,7 @@ src/thousandeyes_sdk/alerts/models/__init__.py
|
||||
src/thousandeyes_sdk/alerts/models/alert.py
|
||||
src/thousandeyes_sdk/alerts/models/alert_detail.py
|
||||
src/thousandeyes_sdk/alerts/models/alert_direction.py
|
||||
src/thousandeyes_sdk/alerts/models/alert_group_type.py
|
||||
src/thousandeyes_sdk/alerts/models/alert_links.py
|
||||
src/thousandeyes_sdk/alerts/models/alert_meta.py
|
||||
src/thousandeyes_sdk/alerts/models/alert_metric_detail.py
|
||||
|
||||
@ -12,7 +12,7 @@ For more information about the alerts, see [Alerts](https://docs.thousandeyes.co
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
@ -123,6 +123,7 @@ Class | Method | HTTP request | Description
|
||||
- [Alert](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-alerts/docs/Alert.md)
|
||||
- [AlertDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-alerts/docs/AlertDetail.md)
|
||||
- [AlertDirection](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-alerts/docs/AlertDirection.md)
|
||||
- [AlertGroupType](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-alerts/docs/AlertGroupType.md)
|
||||
- [AlertLinks](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-alerts/docs/AlertLinks.md)
|
||||
- [AlertMeta](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-alerts/docs/AlertMeta.md)
|
||||
- [AlertMetricDetail](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-alerts/docs/AlertMetricDetail.md)
|
||||
|
||||
12
thousandeyes-sdk-alerts/docs/AlertGroupType.md
Normal file
12
thousandeyes-sdk-alerts/docs/AlertGroupType.md
Normal file
@ -0,0 +1,12 @@
|
||||
# AlertGroupType
|
||||
|
||||
Category of alert type based on the application or network layer and source of the test.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
||||
**notify_on_clear** | **bool** | Send notification when alert clears. | [optional]
|
||||
**is_default** | **bool** | If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type. | [optional]
|
||||
**alert_type** | [**AlertType**](AlertType.md) | |
|
||||
**alert_group_type** | [**AlertGroupType**](AlertGroupType.md) | | [optional]
|
||||
**minimum_sources** | **int** | The minimum number of agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**minimum_sources_pct** | **int** | The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**rounds_violating_mode** | [**AlertRoundsViolationMode**](AlertRoundsViolationMode.md) | | [optional]
|
||||
|
||||
@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
||||
**notify_on_clear** | **bool** | Send notification when alert clears. | [optional]
|
||||
**is_default** | **bool** | If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type. | [optional]
|
||||
**alert_type** | [**AlertType**](AlertType.md) | |
|
||||
**alert_group_type** | [**AlertGroupType**](AlertGroupType.md) | | [optional]
|
||||
**minimum_sources** | **int** | The minimum number of agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**minimum_sources_pct** | **int** | The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**rounds_violating_mode** | [**AlertRoundsViolationMode**](AlertRoundsViolationMode.md) | | [optional]
|
||||
|
||||
@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
||||
**notify_on_clear** | **bool** | Send notification when alert clears. | [optional]
|
||||
**is_default** | **bool** | If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type. | [optional]
|
||||
**alert_type** | [**AlertType**](AlertType.md) | |
|
||||
**alert_group_type** | [**AlertGroupType**](AlertGroupType.md) | | [optional]
|
||||
**minimum_sources** | **int** | The minimum number of agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**minimum_sources_pct** | **int** | The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**rounds_violating_mode** | [**AlertRoundsViolationMode**](AlertRoundsViolationMode.md) | | [optional]
|
||||
|
||||
@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
||||
**notify_on_clear** | **bool** | Send notification when alert clears. | [optional]
|
||||
**is_default** | **bool** | If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type. | [optional]
|
||||
**alert_type** | [**AlertType**](AlertType.md) | |
|
||||
**alert_group_type** | [**AlertGroupType**](AlertGroupType.md) | | [optional]
|
||||
**minimum_sources** | **int** | The minimum number of agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**minimum_sources_pct** | **int** | The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert. | [optional]
|
||||
**rounds_violating_mode** | [**AlertRoundsViolationMode**](AlertRoundsViolationMode.md) | | [optional]
|
||||
|
||||
@ -23,6 +23,7 @@ from thousandeyes_sdk.alerts.api.alerts_api import AlertsApi
|
||||
from thousandeyes_sdk.alerts.models.alert import Alert
|
||||
from thousandeyes_sdk.alerts.models.alert_detail import AlertDetail
|
||||
from thousandeyes_sdk.alerts.models.alert_direction import AlertDirection
|
||||
from thousandeyes_sdk.alerts.models.alert_group_type import AlertGroupType
|
||||
from thousandeyes_sdk.alerts.models.alert_links import AlertLinks
|
||||
from thousandeyes_sdk.alerts.models.alert_meta import AlertMeta
|
||||
from thousandeyes_sdk.alerts.models.alert_metric_detail import AlertMetricDetail
|
||||
|
||||
@ -16,6 +16,7 @@
|
||||
from thousandeyes_sdk.alerts.models.alert import Alert
|
||||
from thousandeyes_sdk.alerts.models.alert_detail import AlertDetail
|
||||
from thousandeyes_sdk.alerts.models.alert_direction import AlertDirection
|
||||
from thousandeyes_sdk.alerts.models.alert_group_type import AlertGroupType
|
||||
from thousandeyes_sdk.alerts.models.alert_links import AlertLinks
|
||||
from thousandeyes_sdk.alerts.models.alert_meta import AlertMeta
|
||||
from thousandeyes_sdk.alerts.models.alert_metric_detail import AlertMetricDetail
|
||||
|
||||
@ -0,0 +1,42 @@
|
||||
# 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 json
|
||||
from enum import Enum
|
||||
from typing_extensions import Self
|
||||
|
||||
|
||||
class AlertGroupType(str, Enum):
|
||||
"""
|
||||
Category of alert type based on the application or network layer and source of the test.
|
||||
"""
|
||||
|
||||
"""
|
||||
allowed enum values
|
||||
"""
|
||||
BROWSER_MINUS_SESSION = 'browser-session'
|
||||
CLOUD_MINUS_ENTERPRISE = 'cloud-enterprise'
|
||||
ENDPOINT = 'endpoint'
|
||||
UNKNOWN = 'unknown'
|
||||
|
||||
@classmethod
|
||||
def from_json(cls, json_str: str) -> Self:
|
||||
"""Create an instance of AlertGroupType from a JSON string"""
|
||||
return cls(json.loads(json_str))
|
||||
|
||||
@classmethod
|
||||
def _missing_(cls, value):
|
||||
"""Handle unknown values"""
|
||||
return cls.UNKNOWN
|
||||
|
||||
@ -19,6 +19,7 @@ import json
|
||||
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
|
||||
from typing import Any, ClassVar, Dict, List, Optional
|
||||
from thousandeyes_sdk.alerts.models.alert_direction import AlertDirection
|
||||
from thousandeyes_sdk.alerts.models.alert_group_type import AlertGroupType
|
||||
from thousandeyes_sdk.alerts.models.alert_rounds_violation_mode import AlertRoundsViolationMode
|
||||
from thousandeyes_sdk.alerts.models.alert_type import AlertType
|
||||
from thousandeyes_sdk.alerts.models.sensitivity_level import SensitivityLevel
|
||||
@ -37,6 +38,7 @@ class BaseRule(BaseModel):
|
||||
notify_on_clear: Optional[StrictBool] = Field(default=None, description="Send notification when alert clears.", alias="notifyOnClear")
|
||||
is_default: Optional[StrictBool] = Field(default=None, description="If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type.", alias="isDefault")
|
||||
alert_type: AlertType = Field(alias="alertType")
|
||||
alert_group_type: Optional[AlertGroupType] = Field(default=None, alias="alertGroupType")
|
||||
minimum_sources: Optional[StrictInt] = Field(default=None, description="The minimum number of agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSources")
|
||||
minimum_sources_pct: Optional[StrictInt] = Field(default=None, description="The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSourcesPct")
|
||||
rounds_violating_mode: Optional[AlertRoundsViolationMode] = Field(default=None, alias="roundsViolatingMode")
|
||||
@ -45,7 +47,7 @@ class BaseRule(BaseModel):
|
||||
include_covered_prefixes: Optional[StrictBool] = Field(default=None, description="Set true to include covered prefixes in the BGP alert rule. Only applicable to BGP alert rules.", alias="includeCoveredPrefixes")
|
||||
sensitivity_level: Optional[SensitivityLevel] = Field(default=None, alias="sensitivityLevel")
|
||||
severity: Optional[Severity] = None
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity"]
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "alertGroupType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -108,6 +110,7 @@ class BaseRule(BaseModel):
|
||||
"notifyOnClear": obj.get("notifyOnClear"),
|
||||
"isDefault": obj.get("isDefault"),
|
||||
"alertType": obj.get("alertType"),
|
||||
"alertGroupType": obj.get("alertGroupType"),
|
||||
"minimumSources": obj.get("minimumSources"),
|
||||
"minimumSourcesPct": obj.get("minimumSourcesPct"),
|
||||
"roundsViolatingMode": obj.get("roundsViolatingMode"),
|
||||
|
||||
@ -19,6 +19,7 @@ import json
|
||||
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
|
||||
from typing import Any, ClassVar, Dict, List, Optional
|
||||
from thousandeyes_sdk.alerts.models.alert_direction import AlertDirection
|
||||
from thousandeyes_sdk.alerts.models.alert_group_type import AlertGroupType
|
||||
from thousandeyes_sdk.alerts.models.alert_notification import AlertNotification
|
||||
from thousandeyes_sdk.alerts.models.alert_rounds_violation_mode import AlertRoundsViolationMode
|
||||
from thousandeyes_sdk.alerts.models.alert_type import AlertType
|
||||
@ -39,6 +40,7 @@ class Rule(BaseModel):
|
||||
notify_on_clear: Optional[StrictBool] = Field(default=None, description="Send notification when alert clears.", alias="notifyOnClear")
|
||||
is_default: Optional[StrictBool] = Field(default=None, description="If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type.", alias="isDefault")
|
||||
alert_type: AlertType = Field(alias="alertType")
|
||||
alert_group_type: Optional[AlertGroupType] = Field(default=None, alias="alertGroupType")
|
||||
minimum_sources: Optional[StrictInt] = Field(default=None, description="The minimum number of agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSources")
|
||||
minimum_sources_pct: Optional[StrictInt] = Field(default=None, description="The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSourcesPct")
|
||||
rounds_violating_mode: Optional[AlertRoundsViolationMode] = Field(default=None, alias="roundsViolatingMode")
|
||||
@ -50,7 +52,7 @@ class Rule(BaseModel):
|
||||
notifications: Optional[AlertNotification] = None
|
||||
test_ids: Optional[List[StrictStr]] = Field(default=None, description="Array of test IDs to link to alert rule (get `testId` from `/tests` endpoint).", alias="testIds")
|
||||
links: Optional[SelfLinks] = Field(default=None, alias="_links")
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity", "notifications", "testIds", "_links"]
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "alertGroupType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity", "notifications", "testIds", "_links"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -119,6 +121,7 @@ class Rule(BaseModel):
|
||||
"notifyOnClear": obj.get("notifyOnClear"),
|
||||
"isDefault": obj.get("isDefault"),
|
||||
"alertType": obj.get("alertType"),
|
||||
"alertGroupType": obj.get("alertGroupType"),
|
||||
"minimumSources": obj.get("minimumSources"),
|
||||
"minimumSourcesPct": obj.get("minimumSourcesPct"),
|
||||
"roundsViolatingMode": obj.get("roundsViolatingMode"),
|
||||
|
||||
@ -19,6 +19,7 @@ import json
|
||||
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
|
||||
from typing import Any, ClassVar, Dict, List, Optional
|
||||
from thousandeyes_sdk.alerts.models.alert_direction import AlertDirection
|
||||
from thousandeyes_sdk.alerts.models.alert_group_type import AlertGroupType
|
||||
from thousandeyes_sdk.alerts.models.alert_notification import AlertNotification
|
||||
from thousandeyes_sdk.alerts.models.alert_rounds_violation_mode import AlertRoundsViolationMode
|
||||
from thousandeyes_sdk.alerts.models.alert_type import AlertType
|
||||
@ -40,6 +41,7 @@ class RuleDetail(BaseModel):
|
||||
notify_on_clear: Optional[StrictBool] = Field(default=None, description="Send notification when alert clears.", alias="notifyOnClear")
|
||||
is_default: Optional[StrictBool] = Field(default=None, description="If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type.", alias="isDefault")
|
||||
alert_type: AlertType = Field(alias="alertType")
|
||||
alert_group_type: Optional[AlertGroupType] = Field(default=None, alias="alertGroupType")
|
||||
minimum_sources: Optional[StrictInt] = Field(default=None, description="The minimum number of agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSources")
|
||||
minimum_sources_pct: Optional[StrictInt] = Field(default=None, description="The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSourcesPct")
|
||||
rounds_violating_mode: Optional[AlertRoundsViolationMode] = Field(default=None, alias="roundsViolatingMode")
|
||||
@ -51,7 +53,7 @@ class RuleDetail(BaseModel):
|
||||
notifications: Optional[AlertNotification] = None
|
||||
tests: Optional[List[SimpleTest]] = None
|
||||
links: Optional[SelfLinks] = Field(default=None, alias="_links")
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity", "notifications", "tests", "_links"]
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "alertGroupType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity", "notifications", "tests", "_links"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -129,6 +131,7 @@ class RuleDetail(BaseModel):
|
||||
"notifyOnClear": obj.get("notifyOnClear"),
|
||||
"isDefault": obj.get("isDefault"),
|
||||
"alertType": obj.get("alertType"),
|
||||
"alertGroupType": obj.get("alertGroupType"),
|
||||
"minimumSources": obj.get("minimumSources"),
|
||||
"minimumSourcesPct": obj.get("minimumSourcesPct"),
|
||||
"roundsViolatingMode": obj.get("roundsViolatingMode"),
|
||||
|
||||
@ -19,6 +19,7 @@ import json
|
||||
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
|
||||
from typing import Any, ClassVar, Dict, List, Optional
|
||||
from thousandeyes_sdk.alerts.models.alert_direction import AlertDirection
|
||||
from thousandeyes_sdk.alerts.models.alert_group_type import AlertGroupType
|
||||
from thousandeyes_sdk.alerts.models.alert_notification import AlertNotification
|
||||
from thousandeyes_sdk.alerts.models.alert_rounds_violation_mode import AlertRoundsViolationMode
|
||||
from thousandeyes_sdk.alerts.models.alert_type import AlertType
|
||||
@ -38,6 +39,7 @@ class RuleDetailUpdate(BaseModel):
|
||||
notify_on_clear: Optional[StrictBool] = Field(default=None, description="Send notification when alert clears.", alias="notifyOnClear")
|
||||
is_default: Optional[StrictBool] = Field(default=None, description="If set to `true`, this alert rule becomes the default for its test type and is automatically applied to newly created tests with relevant metrics. Only one default alert rule is allowed per test type.", alias="isDefault")
|
||||
alert_type: AlertType = Field(alias="alertType")
|
||||
alert_group_type: Optional[AlertGroupType] = Field(default=None, alias="alertGroupType")
|
||||
minimum_sources: Optional[StrictInt] = Field(default=None, description="The minimum number of agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSources")
|
||||
minimum_sources_pct: Optional[StrictInt] = Field(default=None, description="The minimum percentage of all assigned agents or monitors that must meet the specified criteria to trigger the alert.", alias="minimumSourcesPct")
|
||||
rounds_violating_mode: Optional[AlertRoundsViolationMode] = Field(default=None, alias="roundsViolatingMode")
|
||||
@ -48,7 +50,7 @@ class RuleDetailUpdate(BaseModel):
|
||||
severity: Optional[Severity] = None
|
||||
notifications: Optional[AlertNotification] = None
|
||||
test_ids: Optional[List[StrictStr]] = Field(default=None, description="Array of test IDs to link to alert rule (get `testId` from `/tests` endpoint).", alias="testIds")
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity", "notifications", "testIds"]
|
||||
__properties: ClassVar[List[str]] = ["ruleId", "ruleName", "expression", "direction", "notifyOnClear", "isDefault", "alertType", "alertGroupType", "minimumSources", "minimumSourcesPct", "roundsViolatingMode", "roundsViolatingOutOf", "roundsViolatingRequired", "includeCoveredPrefixes", "sensitivityLevel", "severity", "notifications", "testIds"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -114,6 +116,7 @@ class RuleDetailUpdate(BaseModel):
|
||||
"notifyOnClear": obj.get("notifyOnClear"),
|
||||
"isDefault": obj.get("isDefault"),
|
||||
"alertType": obj.get("alertType"),
|
||||
"alertGroupType": obj.get("alertGroupType"),
|
||||
"minimumSources": obj.get("minimumSources"),
|
||||
"minimumSourcesPct": obj.get("minimumSourcesPct"),
|
||||
"roundsViolatingMode": obj.get("roundsViolatingMode"),
|
||||
|
||||
@ -38,6 +38,7 @@ class TestAlertRulesApi(unittest.TestCase):
|
||||
"includeCoveredPrefixes" : true,
|
||||
"roundsViolatingMode" : "exact",
|
||||
"sensitivityLevel" : "medium",
|
||||
"alertGroupType" : "endpoint",
|
||||
"notifyOnClear" : true,
|
||||
"testIds" : [ "281474976710706", "271659" ],
|
||||
"roundsViolatingOutOf" : 5,
|
||||
@ -105,6 +106,7 @@ class TestAlertRulesApi(unittest.TestCase):
|
||||
"includeCoveredPrefixes" : true,
|
||||
"roundsViolatingMode" : "exact",
|
||||
"sensitivityLevel" : "medium",
|
||||
"alertGroupType" : "endpoint",
|
||||
"notifyOnClear" : true,
|
||||
"testIds" : [ "281474976710706", "271659" ],
|
||||
"roundsViolatingOutOf" : 5,
|
||||
@ -179,6 +181,7 @@ class TestAlertRulesApi(unittest.TestCase):
|
||||
"includeCoveredPrefixes" : true,
|
||||
"roundsViolatingMode" : "exact",
|
||||
"sensitivityLevel" : "medium",
|
||||
"alertGroupType" : "endpoint",
|
||||
"notifyOnClear" : true,
|
||||
"roundsViolatingOutOf" : 5,
|
||||
"roundsViolatingRequired" : 2,
|
||||
@ -312,6 +315,7 @@ class TestAlertRulesApi(unittest.TestCase):
|
||||
"includeCoveredPrefixes" : true,
|
||||
"roundsViolatingMode" : "exact",
|
||||
"sensitivityLevel" : "medium",
|
||||
"alertGroupType" : "endpoint",
|
||||
"notifyOnClear" : true,
|
||||
"roundsViolatingOutOf" : 5,
|
||||
"roundsViolatingRequired" : 2,
|
||||
@ -328,6 +332,7 @@ class TestAlertRulesApi(unittest.TestCase):
|
||||
"includeCoveredPrefixes" : true,
|
||||
"roundsViolatingMode" : "exact",
|
||||
"sensitivityLevel" : "medium",
|
||||
"alertGroupType" : "endpoint",
|
||||
"notifyOnClear" : true,
|
||||
"roundsViolatingOutOf" : 5,
|
||||
"roundsViolatingRequired" : 2,
|
||||
@ -354,6 +359,7 @@ class TestAlertRulesApi(unittest.TestCase):
|
||||
"includeCoveredPrefixes" : true,
|
||||
"roundsViolatingMode" : "exact",
|
||||
"sensitivityLevel" : "medium",
|
||||
"alertGroupType" : "endpoint",
|
||||
"notifyOnClear" : true,
|
||||
"testIds" : [ "281474976710706", "271659" ],
|
||||
"roundsViolatingOutOf" : 5,
|
||||
@ -421,6 +427,7 @@ class TestAlertRulesApi(unittest.TestCase):
|
||||
"includeCoveredPrefixes" : true,
|
||||
"roundsViolatingMode" : "exact",
|
||||
"sensitivityLevel" : "medium",
|
||||
"alertGroupType" : "endpoint",
|
||||
"notifyOnClear" : true,
|
||||
"testIds" : [ "281474976710706", "271659" ],
|
||||
"roundsViolatingOutOf" : 5,
|
||||
|
||||
@ -9,7 +9,7 @@ For more information about monitors, see [Inside-Out BGP Visibility](https://doc
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ For more information about credentials, see [Working With Secure Credentials](ht
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ Manage ThousandEyes Dashboards.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ To access Emulation API operations, the following permissions are required:
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ For more information about Endpoint Agents, see [Endpoint Agents](https://docs.t
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ The URLs for these API test data endpoints are provided within the test definiti
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ Manage labels applied to endpoint agents using this API.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ Retrieve results for scheduled and dynamic tests on endpoint agents.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -380,11 +380,11 @@ class TestRealUserEndpointTestResultsApi(unittest.TestCase):
|
||||
"log" : {
|
||||
"browser" : {
|
||||
"name" : "Google Chrome",
|
||||
"version" : "7.0.28.98"
|
||||
"version" : "7.0.29.98"
|
||||
},
|
||||
"creator" : {
|
||||
"name" : "ThousandEyes Endpoint Agent",
|
||||
"version" : "7.0.28"
|
||||
"version" : "7.0.29"
|
||||
},
|
||||
"entries" : [ {
|
||||
"pageref" : "page_1",
|
||||
|
||||
@ -5,7 +5,7 @@ Manage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ With the Events API, you can perform the following tasks on the ThousandEyes pla
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ docs/AgentToServerInstantTestRequest.md
|
||||
docs/AgentToServerInstantTestResponse.md
|
||||
docs/AgentToServerInstantTestsApi.md
|
||||
docs/AgentToServerProperties.md
|
||||
docs/ApiClientAuthentication.md
|
||||
docs/ApiInstantTest.md
|
||||
docs/ApiInstantTestRequest.md
|
||||
docs/ApiInstantTestResponse.md
|
||||
@ -142,6 +143,7 @@ src/thousandeyes_sdk/instant_tests/models/agent_to_server_instant_test.py
|
||||
src/thousandeyes_sdk/instant_tests/models/agent_to_server_instant_test_request.py
|
||||
src/thousandeyes_sdk/instant_tests/models/agent_to_server_instant_test_response.py
|
||||
src/thousandeyes_sdk/instant_tests/models/agent_to_server_properties.py
|
||||
src/thousandeyes_sdk/instant_tests/models/api_client_authentication.py
|
||||
src/thousandeyes_sdk/instant_tests/models/api_instant_test.py
|
||||
src/thousandeyes_sdk/instant_tests/models/api_instant_test_request.py
|
||||
src/thousandeyes_sdk/instant_tests/models/api_instant_test_response.py
|
||||
|
||||
@ -8,7 +8,7 @@ The response does not include the immediate test results. Use the Test Results e
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 7.0.28
|
||||
- API version: 7.0.29
|
||||
- Generator version: 7.6.0
|
||||
- Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator
|
||||
|
||||
@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
|
||||
- [AgentToServerInstantTestRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-instant-tests/docs/AgentToServerInstantTestRequest.md)
|
||||
- [AgentToServerInstantTestResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-instant-tests/docs/AgentToServerInstantTestResponse.md)
|
||||
- [AgentToServerProperties](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-instant-tests/docs/AgentToServerProperties.md)
|
||||
- [ApiClientAuthentication](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-instant-tests/docs/ApiClientAuthentication.md)
|
||||
- [ApiInstantTest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-instant-tests/docs/ApiInstantTest.md)
|
||||
- [ApiInstantTestRequest](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-instant-tests/docs/ApiInstantTestRequest.md)
|
||||
- [ApiInstantTestResponse](https://github.com/thousandeyes/thousandeyes-sdk-python//tree/main/thousandeyes-sdk-instant-tests/docs/ApiInstantTestResponse.md)
|
||||
|
||||
@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**protocol** | [**AgentToAgentTestProtocol**](AgentToAgentTestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | `agentId` of the target agent for the test. |
|
||||
**throughput_measurements** | **bool** | Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent. | [optional] [default to False]
|
||||
**throughput_duration** | **int** | The throughput duration. | [optional] [default to 10000]
|
||||
|
||||
@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**protocol** | [**AgentToAgentTestProtocol**](AgentToAgentTestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | `agentId` of the target agent for the test. |
|
||||
**throughput_measurements** | **bool** | Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent. | [optional] [default to False]
|
||||
**throughput_duration** | **int** | The throughput duration. | [optional] [default to 10000]
|
||||
|
||||
@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**protocol** | [**AgentToAgentTestProtocol**](AgentToAgentTestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | `agentId` of the target agent for the test. |
|
||||
**throughput_measurements** | **bool** | Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent. | [optional] [default to False]
|
||||
**throughput_duration** | **int** | The throughput duration. | [optional] [default to 10000]
|
||||
|
||||
@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**protocol** | [**AgentToAgentTestProtocol**](AgentToAgentTestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | `agentId` of the target agent for the test. |
|
||||
**throughput_measurements** | **bool** | Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent. | [optional] [default to False]
|
||||
**throughput_duration** | **int** | The throughput duration. | [optional] [default to 10000]
|
||||
|
||||
@ -27,6 +27,7 @@ Name | Type | Description | Notes
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**server** | **str** | Target name or IP address. |
|
||||
**dscp** | **str** | DSCP label. | [optional] [readonly]
|
||||
**dscp_id** | [**TestDscpId**](TestDscpId.md) | | [optional]
|
||||
|
||||
@ -27,6 +27,7 @@ Name | Type | Description | Notes
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**server** | **str** | Target name or IP address. |
|
||||
**dscp** | **str** | DSCP label. | [optional] [readonly]
|
||||
**dscp_id** | [**TestDscpId**](TestDscpId.md) | | [optional]
|
||||
|
||||
@ -27,6 +27,7 @@ Name | Type | Description | Notes
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**server** | **str** | Target name or IP address. |
|
||||
**dscp** | **str** | DSCP label. | [optional] [readonly]
|
||||
**dscp_id** | [**TestDscpId**](TestDscpId.md) | | [optional]
|
||||
|
||||
@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
||||
**port** | **int** | Target port. | [optional] [default to 49153]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**server** | **str** | Target name or IP address. |
|
||||
**dscp** | **str** | DSCP label. | [optional] [readonly]
|
||||
**dscp_id** | [**TestDscpId**](TestDscpId.md) | | [optional]
|
||||
|
||||
@ -0,0 +1,12 @@
|
||||
# ApiClientAuthentication
|
||||
|
||||
The OAuth2 client authentication location type.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
||||
**predefined_variables** | [**List[ApiPredefinedVariable]**](ApiPredefinedVariable.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**requests** | [**List[ApiRequest]**](ApiRequest.md) | |
|
||||
**ssl_version_id** | [**TestSslVersionId**](TestSslVersionId.md) | | [optional]
|
||||
**target_time** | **int** | Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior) | [optional]
|
||||
|
||||
@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
||||
**predefined_variables** | [**List[ApiPredefinedVariable]**](ApiPredefinedVariable.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**requests** | [**List[ApiRequest]**](ApiRequest.md) | |
|
||||
**ssl_version_id** | [**TestSslVersionId**](TestSslVersionId.md) | | [optional]
|
||||
**target_time** | **int** | Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior) | [optional]
|
||||
|
||||
@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
||||
**predefined_variables** | [**List[ApiPredefinedVariable]**](ApiPredefinedVariable.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**requests** | [**List[ApiRequest]**](ApiRequest.md) | |
|
||||
**ssl_version_id** | [**TestSslVersionId**](TestSslVersionId.md) | | [optional]
|
||||
**target_time** | **int** | Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior) | [optional]
|
||||
|
||||
@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
||||
**predefined_variables** | [**List[ApiPredefinedVariable]**](ApiPredefinedVariable.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**requests** | [**List[ApiRequest]**](ApiRequest.md) | |
|
||||
**ssl_version_id** | [**TestSslVersionId**](TestSslVersionId.md) | | [optional]
|
||||
**target_time** | **int** | Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior) | [optional]
|
||||
|
||||
@ -9,11 +9,16 @@ Name | Type | Description | Notes
|
||||
**auth_type** | [**ApiRequestAuthType**](ApiRequestAuthType.md) | | [optional]
|
||||
**bearer_token** | **str** | The bearer token if `authType = bearer-token`. | [optional]
|
||||
**body** | **str** | POST/PUT request body. Must be in JSON format. | [optional]
|
||||
**client_authentication** | [**ApiClientAuthentication**](ApiClientAuthentication.md) | | [optional]
|
||||
**client_id** | **str** | The application ID used when `authType` is set to \"oauth2\". | [optional]
|
||||
**client_secret** | **str** | The private client secret used when `authType` is set to \"oauth2\". | [optional]
|
||||
**collect_api_response** | **bool** | Set to `true` if API response body should be collected and saved. Set to `false` if API response body should not be saved. | [optional] [default to True]
|
||||
**headers** | [**List[ApiRequestHeader]**](ApiRequestHeader.md) | Array of API Request Header objects. | [optional]
|
||||
**method** | [**ApiRequestMethod**](ApiRequestMethod.md) | | [optional]
|
||||
**name** | **str** | API step name, must be unique. |
|
||||
**password** | **str** | The password if `authType = basic`. | [optional]
|
||||
**scope** | **str** | Application-specific scope values for the access token when `authType` is \"oauth2\". | [optional]
|
||||
**token_url** | **str** | The endpoint used to request the access token when `authType` is \"oauth2\". | [optional]
|
||||
**url** | **str** | Request url. Supports variables in the format `{{variableName}}`. |
|
||||
**username** | **str** | The username if `authType = basic`. | [optional]
|
||||
**variables** | [**List[ApiRequestVariable]**](ApiRequestVariable.md) | Array of API post request variable objects. | [optional]
|
||||
|
||||
@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
||||
**shared_with_accounts** | [**List[SharedWithAccount]**](SharedWithAccount.md) | | [optional] [readonly]
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
||||
**shared_with_accounts** | **List[str]** | A list of account group identifiers that the test is shared with (get `aid` from `/account-groups` endpoint). | [optional]
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**agents** | [**List[TestAgent]**](TestAgent.md) | A list of objects with `agentId` (required) and `sourceIpAddress` (optional). |
|
||||
|
||||
## Example
|
||||
|
||||
@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
||||
**shared_with_accounts** | [**List[SharedWithAccount]**](SharedWithAccount.md) | | [optional] [readonly]
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**agents** | [**List[AgentResponse]**](AgentResponse.md) | Contains list of agents. | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**type** | **str** | | [optional] [readonly]
|
||||
|
||||
## Example
|
||||
|
||||
@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**recursive_queries** | **bool** | Set true to run query with RD (recursion desired) flag enabled. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
**fixed_packet_rate** | **int** | Sets packets rate sent to measure the network in packets per second. | [optional]
|
||||
|
||||
@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**recursive_queries** | **bool** | Set true to run query with RD (recursion desired) flag enabled. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
**fixed_packet_rate** | **int** | Sets packets rate sent to measure the network in packets per second. | [optional]
|
||||
|
||||
@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**recursive_queries** | **bool** | Set true to run query with RD (recursion desired) flag enabled. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
**fixed_packet_rate** | **int** | Sets packets rate sent to measure the network in packets per second. | [optional]
|
||||
|
||||
@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**recursive_queries** | **bool** | Set true to run query with RD (recursion desired) flag enabled. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
**fixed_packet_rate** | **int** | Sets packets rate sent to measure the network in packets per second. | [optional]
|
||||
|
||||
@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
||||
**dns_transport_protocol** | [**TestDnsTransportProtocol**](TestDnsTransportProtocol.md) | | [optional]
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
||||
**dns_transport_protocol** | [**TestDnsTransportProtocol**](TestDnsTransportProtocol.md) | | [optional]
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**agents** | [**List[TestAgent]**](TestAgent.md) | A list of objects with `agentId` (required) and `sourceIpAddress` (optional). |
|
||||
|
||||
## Example
|
||||
|
||||
@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
||||
**dns_transport_protocol** | [**TestDnsTransportProtocol**](TestDnsTransportProtocol.md) | | [optional]
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**agents** | [**List[AgentResponse]**](AgentResponse.md) | Contains list of agents. | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
||||
**dns_transport_protocol** | [**TestDnsTransportProtocol**](TestDnsTransportProtocol.md) | | [optional]
|
||||
**domain** | **str** | 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** | [**DnsQueryClass**](DnsQueryClass.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**type** | **str** | | [optional] [readonly]
|
||||
|
||||
## Example
|
||||
|
||||
@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**request_type** | [**FtpServerRequestType**](FtpServerRequestType.md) | |
|
||||
**url** | **str** | Target for the test. |
|
||||
**use_active_ftp** | **bool** | Explicitly set the flag to use active FTP. | [optional] [default to False]
|
||||
|
||||
@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**request_type** | [**FtpServerRequestType**](FtpServerRequestType.md) | |
|
||||
**url** | **str** | Target for the test. |
|
||||
**use_active_ftp** | **bool** | Explicitly set the flag to use active FTP. | [optional] [default to False]
|
||||
|
||||
@ -29,6 +29,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**request_type** | [**FtpServerRequestType**](FtpServerRequestType.md) | |
|
||||
**url** | **str** | Target for the test. |
|
||||
**use_active_ftp** | **bool** | Explicitly set the flag to use active FTP. | [optional] [default to False]
|
||||
|
||||
@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**request_type** | [**FtpServerRequestType**](FtpServerRequestType.md) | |
|
||||
**url** | **str** | Target for the test. |
|
||||
**use_active_ftp** | **bool** | Explicitly set the flag to use active FTP. | [optional] [default to False]
|
||||
|
||||
@ -53,6 +53,7 @@ Name | Type | Description | Notes
|
||||
**override_proxy_id** | **str** | ID of the proxy to be used if the default proxy is overridden. | [optional]
|
||||
**collect_proxy_network_data** | **bool** | Indicates whether network data to the proxy should be collected. | [optional] [default to False]
|
||||
**headers** | **List[str]** | HTTP request headers used. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**post_body** | **str** | Enter the body for the HTTP POST request in this field. No special escaping is necessary. If the post body is provided with content, the `requestMethod` is automatically set to POST. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
|
||||
|
||||
@ -53,6 +53,7 @@ Name | Type | Description | Notes
|
||||
**override_proxy_id** | **str** | ID of the proxy to be used if the default proxy is overridden. | [optional]
|
||||
**collect_proxy_network_data** | **bool** | Indicates whether network data to the proxy should be collected. | [optional] [default to False]
|
||||
**headers** | **List[str]** | HTTP request headers used. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**post_body** | **str** | Enter the body for the HTTP POST request in this field. No special escaping is necessary. If the post body is provided with content, the `requestMethod` is automatically set to POST. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
**agents** | [**List[TestAgent]**](TestAgent.md) | A list of objects with `agentId` (required) and `sourceIpAddress` (optional). |
|
||||
|
||||
@ -53,6 +53,7 @@ Name | Type | Description | Notes
|
||||
**override_proxy_id** | **str** | ID of the proxy to be used if the default proxy is overridden. | [optional]
|
||||
**collect_proxy_network_data** | **bool** | Indicates whether network data to the proxy should be collected. | [optional] [default to False]
|
||||
**headers** | **List[str]** | HTTP request headers used. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**post_body** | **str** | Enter the body for the HTTP POST request in this field. No special escaping is necessary. If the post body is provided with content, the `requestMethod` is automatically set to POST. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
**agents** | [**List[AgentResponse]**](AgentResponse.md) | Contains list of agents. | [optional]
|
||||
|
||||
@ -40,6 +40,7 @@ Name | Type | Description | Notes
|
||||
**override_proxy_id** | **str** | ID of the proxy to be used if the default proxy is overridden. | [optional]
|
||||
**collect_proxy_network_data** | **bool** | Indicates whether network data to the proxy should be collected. | [optional] [default to False]
|
||||
**headers** | **List[str]** | HTTP request headers used. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**post_body** | **str** | Enter the body for the HTTP POST request in this field. No special escaping is necessary. If the post body is provided with content, the `requestMethod` is automatically set to POST. | [optional]
|
||||
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [optional]
|
||||
**type** | **str** | | [optional] [readonly]
|
||||
|
||||
@ -61,6 +61,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@ -61,6 +61,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**agents** | [**List[TestAgent]**](TestAgent.md) | A list of objects with `agentId` (required) and `sourceIpAddress` (optional). |
|
||||
|
||||
## Example
|
||||
|
||||
@ -61,6 +61,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**agents** | [**List[AgentResponse]**](AgentResponse.md) | Contains list of agents. | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
@ -48,6 +48,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**type** | **str** | | [optional] [readonly]
|
||||
|
||||
## Example
|
||||
|
||||
@ -24,6 +24,7 @@ Name | Type | Description | Notes
|
||||
**options_regex** | **str** | Options regex, this field does not require escaping. | [optional]
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**register_enabled** | **bool** | Set to true to perform SIP registration on the test target with the SIP REGISTER command. | [optional] [default to False]
|
||||
**sip_target_time** | **int** | Target time for test completion in milliseconds. | [optional]
|
||||
**sip_time_limit** | **int** | Time limit in milliseconds. | [optional] [default to 5]
|
||||
|
||||
@ -24,6 +24,7 @@ Name | Type | Description | Notes
|
||||
**options_regex** | **str** | Options regex, this field does not require escaping. | [optional]
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**register_enabled** | **bool** | Set to true to perform SIP registration on the test target with the SIP REGISTER command. | [optional] [default to False]
|
||||
**sip_target_time** | **int** | Target time for test completion in milliseconds. | [optional]
|
||||
**sip_time_limit** | **int** | Time limit in milliseconds. | [optional] [default to 5]
|
||||
|
||||
@ -24,6 +24,7 @@ Name | Type | Description | Notes
|
||||
**options_regex** | **str** | Options regex, this field does not require escaping. | [optional]
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**register_enabled** | **bool** | Set to true to perform SIP registration on the test target with the SIP REGISTER command. | [optional] [default to False]
|
||||
**sip_target_time** | **int** | Target time for test completion in milliseconds. | [optional]
|
||||
**sip_time_limit** | **int** | Time limit in milliseconds. | [optional] [default to 5]
|
||||
|
||||
@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
||||
**options_regex** | **str** | Options regex, this field does not require escaping. | [optional]
|
||||
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
||||
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**register_enabled** | **bool** | Set to true to perform SIP registration on the test target with the SIP REGISTER command. | [optional] [default to False]
|
||||
**sip_target_time** | **int** | Target time for test completion in milliseconds. | [optional]
|
||||
**sip_time_limit** | **int** | Time limit in milliseconds. | [optional] [default to 5]
|
||||
|
||||
@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
||||
**jitter_buffer** | **int** | De-jitter buffer size in seconds. | [optional] [default to 40]
|
||||
**num_path_traces** | **int** | Number of path traces executed by the agent. | [optional] [default to 3]
|
||||
**port** | **int** | Port number for the chosen protocol. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | Agent ID of the target agent for the test. |
|
||||
|
||||
## Example
|
||||
|
||||
@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
||||
**jitter_buffer** | **int** | De-jitter buffer size in seconds. | [optional] [default to 40]
|
||||
**num_path_traces** | **int** | Number of path traces executed by the agent. | [optional] [default to 3]
|
||||
**port** | **int** | Port number for the chosen protocol. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | Agent ID of the target agent for the test. |
|
||||
**agents** | [**List[TestAgent]**](TestAgent.md) | A list of objects with `agentId` (required) and `sourceIpAddress` (optional). |
|
||||
|
||||
|
||||
@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
||||
**jitter_buffer** | **int** | De-jitter buffer size in seconds. | [optional] [default to 40]
|
||||
**num_path_traces** | **int** | Number of path traces executed by the agent. | [optional] [default to 3]
|
||||
**port** | **int** | Port number for the chosen protocol. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | Agent ID of the target agent for the test. |
|
||||
**agents** | [**List[AgentResponse]**](AgentResponse.md) | Contains list of agents. | [optional]
|
||||
|
||||
|
||||
@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
||||
**jitter_buffer** | **int** | De-jitter buffer size in seconds. | [optional] [default to 40]
|
||||
**num_path_traces** | **int** | Number of path traces executed by the agent. | [optional] [default to 3]
|
||||
**port** | **int** | Port number for the chosen protocol. | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**target_agent_id** | **str** | Agent ID of the target agent for the test. |
|
||||
**type** | **str** | | [optional] [readonly]
|
||||
|
||||
|
||||
@ -62,6 +62,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**credentials** | **List[str]** | Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint). | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
@ -62,6 +62,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**credentials** | **List[str]** | Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint). | [optional]
|
||||
**agents** | [**List[TestAgent]**](TestAgent.md) | A list of objects with `agentId` (required) and `sourceIpAddress` (optional). |
|
||||
|
||||
|
||||
@ -62,6 +62,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**credentials** | **List[str]** | Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint). | [optional]
|
||||
**agents** | [**List[AgentResponse]**](AgentResponse.md) | Contains list of agents. | [optional]
|
||||
|
||||
|
||||
@ -49,6 +49,7 @@ Name | Type | Description | Notes
|
||||
**allow_geolocation** | **bool** | Set true to use the agent’s geolocation by the web page. | [optional] [default to False]
|
||||
**browser_language** | **str** | Set one of the available browser language that you want to use to configure the browser. | [optional]
|
||||
**page_loading_strategy** | [**TestPageLoadingStrategy**](TestPageLoadingStrategy.md) | | [optional]
|
||||
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
||||
**type** | **str** | | [optional] [readonly]
|
||||
|
||||
## Example
|
||||
|
||||
@ -42,6 +42,7 @@ from thousandeyes_sdk.instant_tests.models.agent_to_server_instant_test import A
|
||||
from thousandeyes_sdk.instant_tests.models.agent_to_server_instant_test_request import AgentToServerInstantTestRequest
|
||||
from thousandeyes_sdk.instant_tests.models.agent_to_server_instant_test_response import AgentToServerInstantTestResponse
|
||||
from thousandeyes_sdk.instant_tests.models.agent_to_server_properties import AgentToServerProperties
|
||||
from thousandeyes_sdk.instant_tests.models.api_client_authentication import ApiClientAuthentication
|
||||
from thousandeyes_sdk.instant_tests.models.api_instant_test import ApiInstantTest
|
||||
from thousandeyes_sdk.instant_tests.models.api_instant_test_request import ApiInstantTestRequest
|
||||
from thousandeyes_sdk.instant_tests.models.api_instant_test_response import ApiInstantTestResponse
|
||||
|
||||
@ -25,6 +25,7 @@ from thousandeyes_sdk.instant_tests.models.agent_to_server_instant_test import A
|
||||
from thousandeyes_sdk.instant_tests.models.agent_to_server_instant_test_request import AgentToServerInstantTestRequest
|
||||
from thousandeyes_sdk.instant_tests.models.agent_to_server_instant_test_response import AgentToServerInstantTestResponse
|
||||
from thousandeyes_sdk.instant_tests.models.agent_to_server_properties import AgentToServerProperties
|
||||
from thousandeyes_sdk.instant_tests.models.api_client_authentication import ApiClientAuthentication
|
||||
from thousandeyes_sdk.instant_tests.models.api_instant_test import ApiInstantTest
|
||||
from thousandeyes_sdk.instant_tests.models.api_instant_test_request import ApiInstantTestRequest
|
||||
from thousandeyes_sdk.instant_tests.models.api_instant_test_response import ApiInstantTestResponse
|
||||
|
||||
@ -55,12 +55,13 @@ class AgentToAgentInstantTest(BaseModel):
|
||||
path_trace_mode: Optional[TestPathTraceMode] = Field(default=None, alias="pathTraceMode")
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
protocol: Optional[AgentToAgentTestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
target_agent_id: StrictStr = Field(description="`agentId` of the target agent for the test.", alias="targetAgentId")
|
||||
throughput_measurements: Optional[StrictBool] = Field(default=False, description="Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent.", alias="throughputMeasurements")
|
||||
throughput_duration: Optional[Annotated[int, Field(le=30000, strict=True, ge=5000)]] = Field(default=10000, description="The throughput duration.", alias="throughputDuration")
|
||||
throughput_rate: Optional[Annotated[int, Field(le=1000, strict=True, ge=8)]] = Field(default=None, description="The throughput rate, only applicable for UDP protocol.", alias="throughputRate")
|
||||
fixed_packet_rate: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Sets packets rate sent to measure the network in packets per second.", alias="fixedPacketRate")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "randomizedStartTime", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -174,6 +175,7 @@ class AgentToAgentInstantTest(BaseModel):
|
||||
"pathTraceMode": obj.get("pathTraceMode"),
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"targetAgentId": obj.get("targetAgentId"),
|
||||
"throughputMeasurements": obj.get("throughputMeasurements") if obj.get("throughputMeasurements") is not None else False,
|
||||
"throughputDuration": obj.get("throughputDuration") if obj.get("throughputDuration") is not None else 10000,
|
||||
|
||||
@ -54,13 +54,14 @@ class AgentToAgentInstantTestRequest(BaseModel):
|
||||
path_trace_mode: Optional[TestPathTraceMode] = Field(default=None, alias="pathTraceMode")
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
protocol: Optional[AgentToAgentTestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
target_agent_id: StrictStr = Field(description="`agentId` of the target agent for the test.", alias="targetAgentId")
|
||||
throughput_measurements: Optional[StrictBool] = Field(default=False, description="Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent.", alias="throughputMeasurements")
|
||||
throughput_duration: Optional[Annotated[int, Field(le=30000, strict=True, ge=5000)]] = Field(default=10000, description="The throughput duration.", alias="throughputDuration")
|
||||
throughput_rate: Optional[Annotated[int, Field(le=1000, strict=True, ge=8)]] = Field(default=None, description="The throughput rate, only applicable for UDP protocol.", alias="throughputRate")
|
||||
fixed_packet_rate: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Sets packets rate sent to measure the network in packets per second.", alias="fixedPacketRate")
|
||||
agents: List[TestAgent] = Field(description="A list of objects with `agentId` (required) and `sourceIpAddress` (optional).")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "randomizedStartTime", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -163,6 +164,7 @@ class AgentToAgentInstantTestRequest(BaseModel):
|
||||
"pathTraceMode": obj.get("pathTraceMode"),
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"targetAgentId": obj.get("targetAgentId"),
|
||||
"throughputMeasurements": obj.get("throughputMeasurements") if obj.get("throughputMeasurements") is not None else False,
|
||||
"throughputDuration": obj.get("throughputDuration") if obj.get("throughputDuration") is not None else 10000,
|
||||
|
||||
@ -56,13 +56,14 @@ class AgentToAgentInstantTestResponse(BaseModel):
|
||||
path_trace_mode: Optional[TestPathTraceMode] = Field(default=None, alias="pathTraceMode")
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
protocol: Optional[AgentToAgentTestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
target_agent_id: StrictStr = Field(description="`agentId` of the target agent for the test.", alias="targetAgentId")
|
||||
throughput_measurements: Optional[StrictBool] = Field(default=False, description="Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent.", alias="throughputMeasurements")
|
||||
throughput_duration: Optional[Annotated[int, Field(le=30000, strict=True, ge=5000)]] = Field(default=10000, description="The throughput duration.", alias="throughputDuration")
|
||||
throughput_rate: Optional[Annotated[int, Field(le=1000, strict=True, ge=8)]] = Field(default=None, description="The throughput rate, only applicable for UDP protocol.", alias="throughputRate")
|
||||
fixed_packet_rate: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Sets packets rate sent to measure the network in packets per second.", alias="fixedPacketRate")
|
||||
agents: Optional[List[AgentResponse]] = Field(default=None, description="Contains list of agents.")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "randomizedStartTime", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -183,6 +184,7 @@ class AgentToAgentInstantTestResponse(BaseModel):
|
||||
"pathTraceMode": obj.get("pathTraceMode"),
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"targetAgentId": obj.get("targetAgentId"),
|
||||
"throughputMeasurements": obj.get("throughputMeasurements") if obj.get("throughputMeasurements") is not None else False,
|
||||
"throughputDuration": obj.get("throughputDuration") if obj.get("throughputDuration") is not None else 10000,
|
||||
|
||||
@ -38,13 +38,14 @@ class AgentToAgentProperties(BaseModel):
|
||||
path_trace_mode: Optional[TestPathTraceMode] = Field(default=None, alias="pathTraceMode")
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
protocol: Optional[AgentToAgentTestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
target_agent_id: StrictStr = Field(description="`agentId` of the target agent for the test.", alias="targetAgentId")
|
||||
throughput_measurements: Optional[StrictBool] = Field(default=False, description="Enable or disable throughput measurements. Throughput measurements cannot be enabled when the source or target of the test is a cloud agent.", alias="throughputMeasurements")
|
||||
throughput_duration: Optional[Annotated[int, Field(le=30000, strict=True, ge=5000)]] = Field(default=10000, description="The throughput duration.", alias="throughputDuration")
|
||||
throughput_rate: Optional[Annotated[int, Field(le=1000, strict=True, ge=8)]] = Field(default=None, description="The throughput rate, only applicable for UDP protocol.", alias="throughputRate")
|
||||
fixed_packet_rate: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(default=None, description="Sets packets rate sent to measure the network in packets per second.", alias="fixedPacketRate")
|
||||
type: Optional[StrictStr] = None
|
||||
__properties: ClassVar[List[str]] = ["direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate", "type"]
|
||||
__properties: ClassVar[List[str]] = ["direction", "dscp", "dscpId", "mss", "numPathTraces", "pathTraceMode", "port", "protocol", "randomizedStartTime", "targetAgentId", "throughputMeasurements", "throughputDuration", "throughputRate", "fixedPacketRate", "type"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -110,6 +111,7 @@ class AgentToAgentProperties(BaseModel):
|
||||
"pathTraceMode": obj.get("pathTraceMode"),
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"targetAgentId": obj.get("targetAgentId"),
|
||||
"throughputMeasurements": obj.get("throughputMeasurements") if obj.get("throughputMeasurements") is not None else False,
|
||||
"throughputDuration": obj.get("throughputDuration") if obj.get("throughputDuration") is not None else 10000,
|
||||
|
||||
@ -57,13 +57,14 @@ class AgentToServerInstantTest(BaseModel):
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
server: StrictStr = Field(description="Target name or IP address.")
|
||||
dscp: Optional[StrictStr] = Field(default=None, description="DSCP label.")
|
||||
dscp_id: Optional[TestDscpId] = Field(default=None, alias="dscpId")
|
||||
ipv6_policy: Optional[TestIpv6Policy] = Field(default=None, alias="ipv6Policy")
|
||||
ping_payload_size: Optional[Annotated[int, Field(le=1400, strict=True, ge=0)]] = Field(default=None, description="Payload size (not total packet size) for the end-to-end metric's probes, ping payload size allows values from 0 to 1400 bytes. When set to null, payload sizes are 0 bytes for ICMP-based tests and 1 byte for TCP-based tests.", alias="pingPayloadSize")
|
||||
network_measurements: Optional[StrictBool] = Field(default=False, description="View packet loss in 1-second intervals. This is only available for 1-minute interval tests. Set to `true` to enable network measurements.", alias="networkMeasurements")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "randomizedStartTime", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -178,6 +179,7 @@ class AgentToServerInstantTest(BaseModel):
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"server": obj.get("server"),
|
||||
"dscp": obj.get("dscp"),
|
||||
"dscpId": obj.get("dscpId"),
|
||||
|
||||
@ -56,6 +56,7 @@ class AgentToServerInstantTestRequest(BaseModel):
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
server: StrictStr = Field(description="Target name or IP address.")
|
||||
dscp: Optional[StrictStr] = Field(default=None, description="DSCP label.")
|
||||
dscp_id: Optional[TestDscpId] = Field(default=None, alias="dscpId")
|
||||
@ -63,7 +64,7 @@ class AgentToServerInstantTestRequest(BaseModel):
|
||||
ping_payload_size: Optional[Annotated[int, Field(le=1400, strict=True, ge=0)]] = Field(default=None, description="Payload size (not total packet size) for the end-to-end metric's probes, ping payload size allows values from 0 to 1400 bytes. When set to null, payload sizes are 0 bytes for ICMP-based tests and 1 byte for TCP-based tests.", alias="pingPayloadSize")
|
||||
network_measurements: Optional[StrictBool] = Field(default=False, description="View packet loss in 1-second intervals. This is only available for 1-minute interval tests. Set to `true` to enable network measurements.", alias="networkMeasurements")
|
||||
agents: List[TestAgent] = Field(description="A list of objects with `agentId` (required) and `sourceIpAddress` (optional).")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "randomizedStartTime", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -167,6 +168,7 @@ class AgentToServerInstantTestRequest(BaseModel):
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"server": obj.get("server"),
|
||||
"dscp": obj.get("dscp"),
|
||||
"dscpId": obj.get("dscpId"),
|
||||
|
||||
@ -58,6 +58,7 @@ class AgentToServerInstantTestResponse(BaseModel):
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
server: StrictStr = Field(description="Target name or IP address.")
|
||||
dscp: Optional[StrictStr] = Field(default=None, description="DSCP label.")
|
||||
dscp_id: Optional[TestDscpId] = Field(default=None, alias="dscpId")
|
||||
@ -65,7 +66,7 @@ class AgentToServerInstantTestResponse(BaseModel):
|
||||
ping_payload_size: Optional[Annotated[int, Field(le=1400, strict=True, ge=0)]] = Field(default=None, description="Payload size (not total packet size) for the end-to-end metric's probes, ping payload size allows values from 0 to 1400 bytes. When set to null, payload sizes are 0 bytes for ICMP-based tests and 1 byte for TCP-based tests.", alias="pingPayloadSize")
|
||||
network_measurements: Optional[StrictBool] = Field(default=False, description="View packet loss in 1-second intervals. This is only available for 1-minute interval tests. Set to `true` to enable network measurements.", alias="networkMeasurements")
|
||||
agents: Optional[List[AgentResponse]] = Field(default=None, description="Contains list of agents.")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "randomizedStartTime", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -187,6 +188,7 @@ class AgentToServerInstantTestResponse(BaseModel):
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"server": obj.get("server"),
|
||||
"dscp": obj.get("dscp"),
|
||||
"dscpId": obj.get("dscpId"),
|
||||
|
||||
@ -40,6 +40,7 @@ class AgentToServerProperties(BaseModel):
|
||||
port: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=49153, description="Target port.")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
server: StrictStr = Field(description="Target name or IP address.")
|
||||
dscp: Optional[StrictStr] = Field(default=None, description="DSCP label.")
|
||||
dscp_id: Optional[TestDscpId] = Field(default=None, alias="dscpId")
|
||||
@ -47,7 +48,7 @@ class AgentToServerProperties(BaseModel):
|
||||
ping_payload_size: Optional[Annotated[int, Field(le=1400, strict=True, ge=0)]] = Field(default=None, description="Payload size (not total packet size) for the end-to-end metric's probes, ping payload size allows values from 0 to 1400 bytes. When set to null, payload sizes are 0 bytes for ICMP-based tests and 1 byte for TCP-based tests.", alias="pingPayloadSize")
|
||||
network_measurements: Optional[StrictBool] = Field(default=False, description="View packet loss in 1-second intervals. This is only available for 1-minute interval tests. Set to `true` to enable network measurements.", alias="networkMeasurements")
|
||||
type: Optional[StrictStr] = None
|
||||
__properties: ClassVar[List[str]] = ["bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements", "type"]
|
||||
__properties: ClassVar[List[str]] = ["bandwidthMeasurements", "continuousMode", "fixedPacketRate", "mtuMeasurements", "numPathTraces", "pathTraceMode", "port", "probeMode", "protocol", "randomizedStartTime", "server", "dscp", "dscpId", "ipv6Policy", "pingPayloadSize", "networkMeasurements", "type"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -114,6 +115,7 @@ class AgentToServerProperties(BaseModel):
|
||||
"port": obj.get("port") if obj.get("port") is not None else 49153,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"server": obj.get("server"),
|
||||
"dscp": obj.get("dscp"),
|
||||
"dscpId": obj.get("dscpId"),
|
||||
|
||||
@ -0,0 +1,41 @@
|
||||
# coding: utf-8
|
||||
|
||||
"""
|
||||
Instant Tests API
|
||||
|
||||
The Instant Tests API operations lets you create and run new instant tests. You will need to be a regular user or have the following permissions: * `API Access` * `View tests` The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test.
|
||||
|
||||
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
||||
|
||||
Do not edit the class manually.
|
||||
""" # noqa: E501
|
||||
|
||||
|
||||
from __future__ import annotations
|
||||
import json
|
||||
from enum import Enum
|
||||
from typing_extensions import Self
|
||||
|
||||
|
||||
class ApiClientAuthentication(str, Enum):
|
||||
"""
|
||||
The OAuth2 client authentication location type.
|
||||
"""
|
||||
|
||||
"""
|
||||
allowed enum values
|
||||
"""
|
||||
BASIC_MINUS_AUTH_MINUS_HEADER = 'basic-auth-header'
|
||||
IN_MINUS_BODY = 'in-body'
|
||||
UNKNOWN = 'unknown'
|
||||
|
||||
@classmethod
|
||||
def from_json(cls, json_str: str) -> Self:
|
||||
"""Create an instance of ApiClientAuthentication from a JSON string"""
|
||||
return cls(json.loads(json_str))
|
||||
|
||||
@classmethod
|
||||
def _missing_(cls, value):
|
||||
"""Handle unknown values"""
|
||||
return cls.UNKNOWN
|
||||
|
||||
@ -60,13 +60,14 @@ class ApiInstantTest(BaseModel):
|
||||
predefined_variables: Optional[List[ApiPredefinedVariable]] = Field(default=None, alias="predefinedVariables")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
requests: List[ApiRequest]
|
||||
ssl_version_id: Optional[TestSslVersionId] = Field(default=None, alias="sslVersionId")
|
||||
target_time: Optional[Annotated[int, Field(le=60, strict=True, ge=0)]] = Field(default=None, description="Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior)", alias="targetTime")
|
||||
time_limit: Optional[Annotated[int, Field(le=180, strict=True, ge=5)]] = Field(default=30, description="Time limit for transaction in seconds. Exceeding this limit will result in a Timeout error.", alias="timeLimit")
|
||||
url: StrictStr = Field(description="Target for the test.")
|
||||
credentials: Optional[List[StrictStr]] = Field(default=None, description="Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint).")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "credentials"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "randomizedStartTime", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "credentials"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -195,6 +196,7 @@ class ApiInstantTest(BaseModel):
|
||||
"predefinedVariables": [ApiPredefinedVariable.from_dict(_item) for _item in obj["predefinedVariables"]] if obj.get("predefinedVariables") is not None else None,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"requests": [ApiRequest.from_dict(_item) for _item in obj["requests"]] if obj.get("requests") is not None else None,
|
||||
"sslVersionId": obj.get("sslVersionId"),
|
||||
"targetTime": obj.get("targetTime"),
|
||||
|
||||
@ -59,6 +59,7 @@ class ApiInstantTestRequest(BaseModel):
|
||||
predefined_variables: Optional[List[ApiPredefinedVariable]] = Field(default=None, alias="predefinedVariables")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
requests: List[ApiRequest]
|
||||
ssl_version_id: Optional[TestSslVersionId] = Field(default=None, alias="sslVersionId")
|
||||
target_time: Optional[Annotated[int, Field(le=60, strict=True, ge=0)]] = Field(default=None, description="Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior)", alias="targetTime")
|
||||
@ -66,7 +67,7 @@ class ApiInstantTestRequest(BaseModel):
|
||||
url: StrictStr = Field(description="Target for the test.")
|
||||
credentials: Optional[List[StrictStr]] = Field(default=None, description="Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint).")
|
||||
agents: List[TestAgent] = Field(description="A list of objects with `agentId` (required) and `sourceIpAddress` (optional).")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "credentials", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "randomizedStartTime", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "credentials", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -184,6 +185,7 @@ class ApiInstantTestRequest(BaseModel):
|
||||
"predefinedVariables": [ApiPredefinedVariable.from_dict(_item) for _item in obj["predefinedVariables"]] if obj.get("predefinedVariables") is not None else None,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"requests": [ApiRequest.from_dict(_item) for _item in obj["requests"]] if obj.get("requests") is not None else None,
|
||||
"sslVersionId": obj.get("sslVersionId"),
|
||||
"targetTime": obj.get("targetTime"),
|
||||
|
||||
@ -61,6 +61,7 @@ class ApiInstantTestResponse(BaseModel):
|
||||
predefined_variables: Optional[List[ApiPredefinedVariable]] = Field(default=None, alias="predefinedVariables")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
requests: List[ApiRequest]
|
||||
ssl_version_id: Optional[TestSslVersionId] = Field(default=None, alias="sslVersionId")
|
||||
target_time: Optional[Annotated[int, Field(le=60, strict=True, ge=0)]] = Field(default=None, description="Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior)", alias="targetTime")
|
||||
@ -68,7 +69,7 @@ class ApiInstantTestResponse(BaseModel):
|
||||
url: StrictStr = Field(description="Target for the test.")
|
||||
credentials: Optional[List[StrictStr]] = Field(default=None, description="Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint).")
|
||||
agents: Optional[List[AgentResponse]] = Field(default=None, description="Contains list of agents.")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "credentials", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "randomizedStartTime", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "credentials", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -204,6 +205,7 @@ class ApiInstantTestResponse(BaseModel):
|
||||
"predefinedVariables": [ApiPredefinedVariable.from_dict(_item) for _item in obj["predefinedVariables"]] if obj.get("predefinedVariables") is not None else None,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"requests": [ApiRequest.from_dict(_item) for _item in obj["requests"]] if obj.get("requests") is not None else None,
|
||||
"sslVersionId": obj.get("sslVersionId"),
|
||||
"targetTime": obj.get("targetTime"),
|
||||
|
||||
@ -43,13 +43,14 @@ class ApiProperties(BaseModel):
|
||||
predefined_variables: Optional[List[ApiPredefinedVariable]] = Field(default=None, alias="predefinedVariables")
|
||||
probe_mode: Optional[TestProbeMode] = Field(default=None, alias="probeMode")
|
||||
protocol: Optional[TestProtocol] = None
|
||||
randomized_start_time: Optional[StrictBool] = Field(default=False, description="Indicates whether agents should randomize the start time in each test round.", alias="randomizedStartTime")
|
||||
requests: List[ApiRequest]
|
||||
ssl_version_id: Optional[TestSslVersionId] = Field(default=None, alias="sslVersionId")
|
||||
target_time: Optional[Annotated[int, Field(le=60, strict=True, ge=0)]] = Field(default=None, description="Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior)", alias="targetTime")
|
||||
time_limit: Optional[Annotated[int, Field(le=180, strict=True, ge=5)]] = Field(default=30, description="Time limit for transaction in seconds. Exceeding this limit will result in a Timeout error.", alias="timeLimit")
|
||||
url: StrictStr = Field(description="Target for the test.")
|
||||
type: Optional[StrictStr] = None
|
||||
__properties: ClassVar[List[str]] = ["collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "type"]
|
||||
__properties: ClassVar[List[str]] = ["collectProxyNetworkData", "followRedirects", "mtuMeasurements", "networkMeasurements", "numPathTraces", "overrideAgentProxy", "overrideProxyId", "pathTraceMode", "predefinedVariables", "probeMode", "protocol", "randomizedStartTime", "requests", "sslVersionId", "targetTime", "timeLimit", "url", "type"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -130,6 +131,7 @@ class ApiProperties(BaseModel):
|
||||
"predefinedVariables": [ApiPredefinedVariable.from_dict(_item) for _item in obj["predefinedVariables"]] if obj.get("predefinedVariables") is not None else None,
|
||||
"probeMode": obj.get("probeMode"),
|
||||
"protocol": obj.get("protocol"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"requests": [ApiRequest.from_dict(_item) for _item in obj["requests"]] if obj.get("requests") is not None else None,
|
||||
"sslVersionId": obj.get("sslVersionId"),
|
||||
"targetTime": obj.get("targetTime"),
|
||||
|
||||
@ -18,6 +18,7 @@ import json
|
||||
|
||||
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
|
||||
from typing import Any, ClassVar, Dict, List, Optional
|
||||
from thousandeyes_sdk.instant_tests.models.api_client_authentication import ApiClientAuthentication
|
||||
from thousandeyes_sdk.instant_tests.models.api_request_assertion import ApiRequestAssertion
|
||||
from thousandeyes_sdk.instant_tests.models.api_request_auth_type import ApiRequestAuthType
|
||||
from thousandeyes_sdk.instant_tests.models.api_request_header import ApiRequestHeader
|
||||
@ -34,16 +35,21 @@ class ApiRequest(BaseModel):
|
||||
auth_type: Optional[ApiRequestAuthType] = Field(default=None, alias="authType")
|
||||
bearer_token: Optional[StrictStr] = Field(default=None, description="The bearer token if `authType = bearer-token`.", alias="bearerToken")
|
||||
body: Optional[StrictStr] = Field(default=None, description="POST/PUT request body. Must be in JSON format.")
|
||||
client_authentication: Optional[ApiClientAuthentication] = Field(default=None, alias="clientAuthentication")
|
||||
client_id: Optional[StrictStr] = Field(default=None, description="The application ID used when `authType` is set to \"oauth2\".", alias="clientId")
|
||||
client_secret: Optional[StrictStr] = Field(default=None, description="The private client secret used when `authType` is set to \"oauth2\".", alias="clientSecret")
|
||||
collect_api_response: Optional[StrictBool] = Field(default=True, description="Set to `true` if API response body should be collected and saved. Set to `false` if API response body should not be saved.", alias="collectApiResponse")
|
||||
headers: Optional[List[ApiRequestHeader]] = Field(default=None, description="Array of API Request Header objects.")
|
||||
method: Optional[ApiRequestMethod] = None
|
||||
name: StrictStr = Field(description="API step name, must be unique.")
|
||||
password: Optional[StrictStr] = Field(default=None, description="The password if `authType = basic`.")
|
||||
scope: Optional[StrictStr] = Field(default=None, description="Application-specific scope values for the access token when `authType` is \"oauth2\".")
|
||||
token_url: Optional[StrictStr] = Field(default=None, description="The endpoint used to request the access token when `authType` is \"oauth2\".", alias="tokenUrl")
|
||||
url: StrictStr = Field(description="Request url. Supports variables in the format `{{variableName}}`.")
|
||||
username: Optional[StrictStr] = Field(default=None, description="The username if `authType = basic`.")
|
||||
variables: Optional[List[ApiRequestVariable]] = Field(default=None, description="Array of API post request variable objects.")
|
||||
wait_time_ms: Optional[StrictInt] = Field(default=None, description="Post request delay before executing the next API requests, in milliseconds.", alias="waitTimeMs")
|
||||
__properties: ClassVar[List[str]] = ["assertions", "authType", "bearerToken", "body", "collectApiResponse", "headers", "method", "name", "password", "url", "username", "variables", "waitTimeMs"]
|
||||
__properties: ClassVar[List[str]] = ["assertions", "authType", "bearerToken", "body", "clientAuthentication", "clientId", "clientSecret", "collectApiResponse", "headers", "method", "name", "password", "scope", "tokenUrl", "url", "username", "variables", "waitTimeMs"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -122,11 +128,16 @@ class ApiRequest(BaseModel):
|
||||
"authType": obj.get("authType"),
|
||||
"bearerToken": obj.get("bearerToken"),
|
||||
"body": obj.get("body"),
|
||||
"clientAuthentication": obj.get("clientAuthentication"),
|
||||
"clientId": obj.get("clientId"),
|
||||
"clientSecret": obj.get("clientSecret"),
|
||||
"collectApiResponse": obj.get("collectApiResponse") if obj.get("collectApiResponse") is not None else True,
|
||||
"headers": [ApiRequestHeader.from_dict(_item) for _item in obj["headers"]] if obj.get("headers") is not None else None,
|
||||
"method": obj.get("method"),
|
||||
"name": obj.get("name"),
|
||||
"password": obj.get("password"),
|
||||
"scope": obj.get("scope"),
|
||||
"tokenUrl": obj.get("tokenUrl"),
|
||||
"url": obj.get("url"),
|
||||
"username": obj.get("username"),
|
||||
"variables": [ApiRequestVariable.from_dict(_item) for _item in obj["variables"]] if obj.get("variables") is not None else None,
|
||||
|
||||
@ -28,6 +28,7 @@ class ApiRequestAuthType(str, Enum):
|
||||
NONE = 'none'
|
||||
BASIC = 'basic'
|
||||
BEARER_MINUS_TOKEN = 'bearer-token'
|
||||
OAUTH2 = 'oauth2'
|
||||
UNKNOWN = 'unknown'
|
||||
|
||||
@classmethod
|
||||
|
||||
@ -45,7 +45,8 @@ class DnsSecInstantTest(BaseModel):
|
||||
shared_with_accounts: Optional[List[SharedWithAccount]] = Field(default=None, alias="sharedWithAccounts")
|
||||
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")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "domain", "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]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "domain", "dnsQueryClass", "randomizedStartTime"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -150,7 +151,8 @@ class DnsSecInstantTest(BaseModel):
|
||||
"labels": [TestLabel.from_dict(_item) for _item in obj["labels"]] if obj.get("labels") is not None else None,
|
||||
"sharedWithAccounts": [SharedWithAccount.from_dict(_item) for _item in obj["sharedWithAccounts"]] if obj.get("sharedWithAccounts") is not None else None,
|
||||
"domain": obj.get("domain"),
|
||||
"dnsQueryClass": obj.get("dnsQueryClass")
|
||||
"dnsQueryClass": obj.get("dnsQueryClass"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False
|
||||
})
|
||||
return _obj
|
||||
|
||||
|
||||
@ -44,8 +44,9 @@ class DnsSecInstantTestRequest(BaseModel):
|
||||
shared_with_accounts: Optional[List[StrictStr]] = Field(default=None, description="A list of account group identifiers that the test is shared with (get `aid` from `/account-groups` endpoint).", alias="sharedWithAccounts")
|
||||
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")
|
||||
agents: List[TestAgent] = Field(description="A list of objects with `agentId` (required) and `sourceIpAddress` (optional).")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "domain", "dnsQueryClass", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "domain", "dnsQueryClass", "randomizedStartTime", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -140,6 +141,7 @@ class DnsSecInstantTestRequest(BaseModel):
|
||||
"sharedWithAccounts": obj.get("sharedWithAccounts"),
|
||||
"domain": obj.get("domain"),
|
||||
"dnsQueryClass": obj.get("dnsQueryClass"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"agents": [TestAgent.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None
|
||||
})
|
||||
return _obj
|
||||
|
||||
@ -46,8 +46,9 @@ class DnsSecInstantTestResponse(BaseModel):
|
||||
shared_with_accounts: Optional[List[SharedWithAccount]] = Field(default=None, alias="sharedWithAccounts")
|
||||
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")
|
||||
agents: Optional[List[AgentResponse]] = Field(default=None, description="Contains list of agents.")
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "domain", "dnsQueryClass", "agents"]
|
||||
__properties: ClassVar[List[str]] = ["createdBy", "createdDate", "description", "liveShare", "modifiedBy", "modifiedDate", "savedEvent", "testId", "testName", "type", "_links", "labels", "sharedWithAccounts", "domain", "dnsQueryClass", "randomizedStartTime", "agents"]
|
||||
|
||||
model_config = ConfigDict(
|
||||
populate_by_name=True,
|
||||
@ -160,6 +161,7 @@ class DnsSecInstantTestResponse(BaseModel):
|
||||
"sharedWithAccounts": [SharedWithAccount.from_dict(_item) for _item in obj["sharedWithAccounts"]] if obj.get("sharedWithAccounts") is not None else None,
|
||||
"domain": obj.get("domain"),
|
||||
"dnsQueryClass": obj.get("dnsQueryClass"),
|
||||
"randomizedStartTime": obj.get("randomizedStartTime") if obj.get("randomizedStartTime") is not None else False,
|
||||
"agents": [AgentResponse.from_dict(_item) for _item in obj["agents"]] if obj.get("agents") is not None else None
|
||||
})
|
||||
return _obj
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user