mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 14:36:50 +00:00
62bed5b328
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
47 lines
2.9 KiB
Markdown
47 lines
2.9 KiB
Markdown
# ApiProperties
|
|
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**collect_proxy_network_data** | **bool** | Indicates whether network data to the proxy should be collected. | [optional] [default to False]
|
|
**follow_redirects** | **bool** | To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`. | [optional] [default to True]
|
|
**mtu_measurements** | **bool** | Set `true` to measure MTU sizes on network from agents to the target. | [optional]
|
|
**network_measurements** | **bool** | Enable or disable network measurements. Set to true to enable or false to disable network measurements. | [optional] [default to True]
|
|
**num_path_traces** | **int** | Number of path traces executed by the agent. | [optional] [default to 3]
|
|
**override_agent_proxy** | **bool** | Flag indicating if a proxy other than the default should be used. To override the default proxy for agents, set to `true` and specify a value for `overrideProxyId`. | [optional] [default to False]
|
|
**override_proxy_id** | **str** | ID of the proxy to be used if the default proxy is overridden. | [optional]
|
|
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
|
**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]
|
|
**time_limit** | **int** | Time limit for transaction in seconds. Exceeding this limit will result in a Timeout error. | [optional] [default to 30]
|
|
**url** | **str** | Target for the test. |
|
|
**type** | **str** | | [optional] [readonly]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.instant_tests.models.api_properties import ApiProperties
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of ApiProperties from a JSON string
|
|
api_properties_instance = ApiProperties.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(ApiProperties.to_json())
|
|
|
|
# convert the object into a dict
|
|
api_properties_dict = api_properties_instance.to_dict()
|
|
# create an instance of ApiProperties from a dict
|
|
api_properties_from_dict = ApiProperties.from_dict(api_properties_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)
|
|
|
|
|