thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/WebTransactionInstantTest.md
Miguel Pragosa dcf0f54d56
Some checks failed
Python CI / build (push) Has been cancelled
[GitHub Bot] Generated python SDK (#96)
Co-authored-by: API Team <api-team@thousandeyes.com>
2025-04-02 12:58:49 +01:00

7.8 KiB
Raw Blame History

WebTransactionInstantTest

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[TestLabel]** Labels to which the test is assigned. This field is not returned for Instant Tests. [optional] [readonly]
shared_with_accounts **List[SharedWithAccount]** [optional] [readonly]
auth_type TestAuthType [optional]
agent_interfaces AgentInterfaces [optional]
bandwidth_measurements bool Set to `true` to enable bandwidth measurements, only applies to Enterprise agents assigned to the test. [optional]
client_certificate str String representation (containing newline characters) of client certificate, the private key must be placed first, then the certificate. [optional]
content_regex str Content regex, this field does not require escaping. [optional]
custom_headers TestCustomHeaders [optional]
desired_status_code str Specify the HTTP status code value that indicates a successful response. The default value accepts any 2xx or 3xx status code. [optional] [default to 'default']
download_limit int Specifies maximum number of bytes to download from the target object. [optional]
dns_override str IP address to use for DNS override. [optional]
http_target_time int Target time for HTTP server completion, specified in milliseconds. [optional]
http_time_limit int HTTP time limit in seconds. [optional] [default to 5]
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]
include_headers bool Set to `true` to capture response headers for objects loaded by the test. [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]
o_auth OAuth [optional]
password str Password for Basic/NTLM authentication. [optional]
path_trace_mode TestPathTraceMode [optional]
probe_mode TestProbeMode [optional]
protocol TestProtocol [optional]
ssl_version str Reflects the verbose SSL protocol version used by a test. [optional] [readonly]
ssl_version_id TestSslVersionId [optional]
url str Target for the test.
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]
username str Username for Basic/NTLM authentication. [optional]
verify_certificate bool Ignore or acknowledge certificate errors. Set to false to ignore certificate errors. [optional] [default to False]
allow_unsafe_legacy_renegotiation bool Allows TLS renegotiation with servers not supporting RFC 5746. Default Set to true to allow unsafe legacy renegotiation. [optional] [default to True]
follow_redirects bool To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`. [optional] [default to True]
fixed_packet_rate int Sets packets rate sent to measure the network in packets per second. [optional]
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]
collect_proxy_network_data bool Indicates whether network data to the proxy should be collected. [optional] [default to False]
emulated_device_id str ID of the emulated device, if specified when the test was created. [optional]
target_time int Target completion time. The default is 50% of the specified time limit in seconds. (Set to 0 to use the default behavior). [optional]
time_limit int Time limit for transaction in seconds. [optional] [default to 30]
transaction_script str JavaScript of a web transaction test. Quotes must be escaped (precede &quot; characters with \ ).
block_domains str Domains or full object URLs to be excluded from metrics and waterfall data for transaction tests. [optional]
disable_screenshot bool Enables or disables screenshots on error. Set true to not capture [optional] [default to False]
allow_mic_and_camera bool Set true allow the use of a fake mic and camera in the browser. [optional] [default to False]
allow_geolocation bool Set true to use the agents geolocation by the web page. [optional] [default to False]
browser_language str Set one of the available browser language that you want to use to configure the browser. [optional]
page_loading_strategy TestPageLoadingStrategy [optional]
randomized_start_time bool Indicates whether agents should randomize the start time in each test round. [optional] [default to False]
credentials List[str] Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint). [optional]

Example

from thousandeyes_sdk.tests.models.web_transaction_instant_test import WebTransactionInstantTest

# TODO update the JSON string below
json = "{}"
# create an instance of WebTransactionInstantTest from a JSON string
web_transaction_instant_test_instance = WebTransactionInstantTest.from_json(json)
# print the JSON string representation of the object
print(WebTransactionInstantTest.to_json())

# convert the object into a dict
web_transaction_instant_test_dict = web_transaction_instant_test_instance.to_dict()
# create an instance of WebTransactionInstantTest from a dict
web_transaction_instant_test_from_dict = WebTransactionInstantTest.from_dict(web_transaction_instant_test_dict)

[Back to Model list] [Back to API list] [Back to README]