mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 06:26:51 +00:00
745e74afc4
* CP-2189 Update SDK names for admin and monitors modules * CP-2189 Move client to core * CP-2189 Change client to core
62 lines
4.7 KiB
Markdown
62 lines
4.7 KiB
Markdown
# EndpointScheduledTest
|
|
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**aid** | **str** | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. | [optional]
|
|
**links** | [**EndpointTestLinks**](EndpointTestLinks.md) | | [optional]
|
|
**agent_selector_config** | [**EndpointAgentSelectorConfig**](EndpointAgentSelectorConfig.md) | | [optional]
|
|
**created_date** | **datetime** | UTC created date (ISO date-time format). | [optional] [readonly]
|
|
**interval** | [**TestInterval**](TestInterval.md) | | [optional]
|
|
**is_enabled** | **bool** | Indicates if test is enabled. | [optional] [default to True]
|
|
**is_saved_event** | **bool** | Indicates if the test is a saved event. | [optional] [readonly]
|
|
**has_path_trace_in_session** | **bool** | Enables \"in session\" path trace. When enabled, this option initiates a TCP session with the target server and sends path trace packets within the established TCP session. | [optional]
|
|
**modified_date** | **datetime** | UTC last modification date (ISO date-time format). | [optional] [readonly]
|
|
**network_measurements** | **bool** | Enable or disable network measurements. Set to true to enable or false to disable network measurements. | [optional] [default to True]
|
|
**port** | **int** | Port number, if not specified, the port is selected based on a protocol (HTTP 80, HTTPS 443). | [optional]
|
|
**protocol** | [**EndpointTestProtocol**](EndpointTestProtocol.md) | | [optional]
|
|
**server** | **str** | Target domain name or IP address. | [optional]
|
|
**test_id** | **str** | Each test is assigned a unique ID to access test data from other endpoints. | [optional] [readonly]
|
|
**test_name** | **str** | Name of the test. | [optional]
|
|
**type** | **str** | Type of test being queried. | [readonly]
|
|
**tcp_probe_mode** | [**TestProbeModeResponse**](TestProbeModeResponse.md) | | [optional]
|
|
**alert_rules** | [**List[AlertRule]**](AlertRule.md) | Contains list of enabled alert rule objects. | [optional]
|
|
**labels** | [**List[TestLabel]**](TestLabel.md) | | [optional] [readonly]
|
|
**auth_type** | [**EndpointTestAuthType**](EndpointTestAuthType.md) | | [optional]
|
|
**http_time_limit** | **int** | Maximum amount of time in milliseconds the agents wait before a request times out. | [optional]
|
|
**url** | **str** | Test target URL. Optionally, you can specify a protocol (http or https). If no protocol is provided, the default `https` protocol is used. | [optional]
|
|
**username** | **str** | Username for Basic/NTLM authentication. | [optional]
|
|
**ssl_version_id** | [**TestSslVersionId**](TestSslVersionId.md) | | [optional]
|
|
**verify_certificate** | **bool** | Flag indicating if a certificate should be verified. | [optional]
|
|
**content_regex** | **str** | Content regex, this field does not require escaping. | [optional]
|
|
**follow_redirects** | **bool** | To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`. | [optional] [default to True]
|
|
**http_target_time** | **int** | Target time for HTTP server completion, specified in milliseconds. | [optional]
|
|
**http_version** | **int** | HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1. | [optional] [default to 2]
|
|
**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]
|
|
**ssl_version** | **str** | Reflects the verbose SSL protocol version used by a test. | [optional] [readonly]
|
|
**use_ntlm** | **bool** | Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set. | [optional]
|
|
**user_agent** | **str** | User-agent string to be provided during the test. | [optional]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.endpoint_test_results.models.endpoint_scheduled_test import EndpointScheduledTest
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of EndpointScheduledTest from a JSON string
|
|
endpoint_scheduled_test_instance = EndpointScheduledTest.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(EndpointScheduledTest.to_json())
|
|
|
|
# convert the object into a dict
|
|
endpoint_scheduled_test_dict = endpoint_scheduled_test_instance.to_dict()
|
|
# create an instance of EndpointScheduledTest from a dict
|
|
endpoint_scheduled_test_from_dict = EndpointScheduledTest.from_dict(endpoint_scheduled_test_dict)
|
|
```
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
|