mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 14:36:50 +00:00
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
3.3 KiB
3.3 KiB
UpdateBgpTestRequest
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| 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] |
| enabled | bool | Test is enabled. | [optional] [default to True] |
| monitors | List[str] | Contains list of BGP monitor IDs (get `monitorId` from `/monitors` endpoint) | [optional] |
| include_covered_prefixes | bool | Indicate if queries for subprefixes detected under this prefix should included. | [optional] |
| use_public_bgp | bool | Indicate if all available public BGP monitors should be used, when ommited defaults to `bgpMeasurements` value. | [optional] [default to True] |
| alerts_enabled | bool | Indicates if alerts are enabled. | [optional] |
| 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] |
Example
from thousandeyes_sdk.tests.models.update_bgp_test_request import UpdateBgpTestRequest
# TODO update the JSON string below
json = "{}"
# create an instance of UpdateBgpTestRequest from a JSON string
update_bgp_test_request_instance = UpdateBgpTestRequest.from_json(json)
# print the JSON string representation of the object
print(UpdateBgpTestRequest.to_json())
# convert the object into a dict
update_bgp_test_request_dict = update_bgp_test_request_instance.to_dict()
# create an instance of UpdateBgpTestRequest from a dict
update_bgp_test_request_from_dict = UpdateBgpTestRequest.from_dict(update_bgp_test_request_dict)