mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 16:05:30 +00:00
4.4 KiB
4.4 KiB
VoiceTestRequest
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| interval | TestInterval | ||
| alerts_enabled | bool | Indicates if alerts are enabled. | [optional] |
| enabled | bool | Test is enabled. | [optional] [default to True] |
| alert_rules | List[str] | List of alert rules IDs to apply to the test (get `ruleId` from `/alerts/rules` endpoint. If `alertsEnabled` is set to `true` and `alertRules` is not included on test creation or update, applicable user default alert rules will be used) | [optional] |
| created_by | str | User that created the test. | [optional] [readonly] |
| created_date | datetime | UTC created date (ISO date-time format). | [optional] [readonly] |
| description | str | A description of the test. | [optional] |
| live_share | bool | Indicates if the test is shared with the account group. | [optional] [readonly] |
| modified_by | str | User that modified the test. | [optional] [readonly] |
| modified_date | datetime | UTC last modification date (ISO date-time format). | [optional] [readonly] |
| saved_event | bool | Indicates if the test is a saved event. Note: Saved Events are now called Private Snapshots in the user interface. This change does not affect API. | [optional] [readonly] |
| test_id | str | Each test is assigned an unique ID; this is used to access test information and results from other endpoints. | [optional] [readonly] |
| test_name | str | The name of the test. Test name must be unique. | [optional] |
| type | str | [optional] [readonly] | |
| links | TestLinks | [optional] | |
| labels | List[str] | Contains list of test label IDs (get `labelId` from `/labels` endpoint) | [optional] |
| shared_with_accounts | List[str] | Contains list of account group IDs. Test is shared with the listed account groups (get `aid` from `/account-groups` endpoint) | [optional] |
| codec | str | Codec label | [optional] [readonly] |
| codec_id | str | Coded ID, see the list of acceptable values | [optional] |
| dscp | str | DSCP label. | [optional] [readonly] |
| dscp_id | TestDscpId | [optional] | |
| duration | int | Duration of the test in seconds. | [optional] [default to 5] |
| 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. | |
| bgp_measurements | bool | Set to `true` to enable bgp measurements. | [optional] [default to True] |
| use_public_bgp | bool | Indicate if all available public BGP monitors should be used, when ommited defaults to `bgpMeasurements` value. | [optional] [default to True] |
| monitors | **List[Monitor]** | Contains list of enabled BGP monitors. | [optional] [readonly] |
| agents | **List[TestAgentRequest]** | Contains list of Agent IDs (get `agentId` from `/agents` endpoint). |
Example
from thousandeyes_sdk.tests.models.voice_test_request import VoiceTestRequest
# TODO update the JSON string below
json = "{}"
# create an instance of VoiceTestRequest from a JSON string
voice_test_request_instance = VoiceTestRequest.from_json(json)
# print the JSON string representation of the object
print(VoiceTestRequest.to_json())
# convert the object into a dict
voice_test_request_dict = voice_test_request_instance.to_dict()
# create an instance of VoiceTestRequest from a dict
voice_test_request_from_dict = VoiceTestRequest.from_dict(voice_test_request_dict)