thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/UpdatePageLoadTest.md
Jack Browne 92b9a0126c
CP-2126 Refactor HTTP client into shared package (#5)
* CP-2126 Refactor HTTP client into shared package

* CP-2126 Regenerate Python SDK
2024-05-23 11:57:23 +01:00

7.7 KiB
Raw Blame History

UpdatePageLoadTest

Properties

Name Type Description Notes
interval TestInterval
alerts_enabled bool Indicates if alerts are enabled. [optional]
enabled bool Test is enabled. [optional] [default to True]
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]
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. [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]
auth_type TestAuthType [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 Verify content using a regular expression. 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. [optional] [default to '200']
emulated_device_id str id of the emulated device, if one was given when the test was created [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_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]
page_load_target_time int Target time for page load completion, specified in seconds and cannot exceed the `pageLoadTimeLimit`. [optional]
page_load_time_limit int Page load time limit. Must be larger than the `httpTimeLimit`. [optional] [default to 10]
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]
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]
fixed_packet_rate int Sets packets rate sent to measure the network in packets per second. [optional]
agents **List[AgentRequest]** [optional]
bgp_measurements bool Set to `true` to enable bgp measurements. [optional] [default to True]
use_public_bgp bool Indicate if all available public BGP monitors should be used, when ommited defaults to `bgpMeasurements` value. [optional] [default to True]
monitors List[str] Contains list of BGP monitor IDs (get `monitorId` from `/monitors` endpoint) [optional]
http_interval TestHttpInterval [optional]
subinterval TestSubInterval [optional]

Example

from thousandeyes_sdk.tests.models.update_page_load_test import UpdatePageLoadTest

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

# convert the object into a dict
update_page_load_test_dict = update_page_load_test_instance.to_dict()
# create an instance of UpdatePageLoadTest from a dict
update_page_load_test_from_dict = UpdatePageLoadTest.from_dict(update_page_load_test_dict)

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