thousandeyes-sdk-python/thousandeyes-sdk-endpoint-test-results/docs/EndpointScheduledTest.md
2025-03-26 14:40:58 +00:00

60 lines
4.5 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]
**is_prioritized** | **bool** | Indicates whether the test should be prioritized when the number of tests assigned to an agent exceeds the license limit. | [optional] [default to False]
**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. **Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect API. | [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]
**labels** | [**List[TestLabel]**](TestLabel.md) | Labels to which the test is assigned. This field is not returned for Instant Tests. | [optional] [readonly]
**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]
**protocol** | [**EndpointTestProtocol**](EndpointTestProtocol.md) | | [optional]
**ip_version** | [**EndpointIpVersionTemplate**](EndpointIpVersionTemplate.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]
**port** | **int** | Port number. | [optional] [default to 443]
**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] [default to 5000]
**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] [default to True]
**url** | **str** | The test target URL. | [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]
**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]
## 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)