Class: DatadogAPIClient::V1::SyntheticsTestRequest
- Inherits:
-
Object
- Object
- DatadogAPIClient::V1::SyntheticsTestRequest
- Includes:
- BaseGenericModel
- Defined in:
- lib/datadog_api_client/v1/models/synthetics_test_request.rb
Overview
Object describing the Synthetic test request.
Instance Attribute Summary collapse
-
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
-
#allow_insecure ⇒ Object
Allows loading insecure content for an HTTP request in a multistep test step.
-
#basic_auth ⇒ Object
Object to handle basic authentication when performing the test.
-
#body ⇒ Object
Body to include in the test.
-
#body_type ⇒ Object
Type of the request body.
-
#call_type ⇒ Object
The type of gRPC call to perform.
-
#certificate ⇒ Object
Client certificate to use when performing the test request.
-
#certificate_domains ⇒ Object
By default, the client certificate is applied on the domain of the starting URL for browser tests.
-
#compressed_json_descriptor ⇒ Object
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
-
#compressed_proto_file ⇒ Object
A protobuf file that needs to be gzipped first then base64 encoded.
-
#dns_server ⇒ Object
DNS server to use for DNS tests.
-
#dns_server_port ⇒ Object
DNS server port to use for DNS tests.
-
#files ⇒ Object
Files to be used as part of the request in the test.
-
#follow_redirects ⇒ Object
Specifies whether or not the request follows redirects.
-
#headers ⇒ Object
Headers to include when performing the test.
-
#host ⇒ Object
Host name to perform the test with.
-
#http_version ⇒ Object
HTTP version to use for a Synthetic test.
-
#message ⇒ Object
Message to send for UDP or WebSocket tests.
-
#metadata ⇒ Object
Metadata to include when performing the gRPC test.
-
#method ⇒ Object
Either the HTTP method/verb to use or a gRPC method available on the service set in the ‘service` field.
-
#no_saving_response_body ⇒ Object
Determines whether or not to save the response body.
-
#number_of_packets ⇒ Object
readonly
Number of pings to use per test.
-
#persist_cookies ⇒ Object
Persist cookies across redirects.
-
#port ⇒ Object
Port to use when performing the test.
-
#proxy ⇒ Object
The proxy to perform the test.
-
#query ⇒ Object
Query to use for the test.
-
#servername ⇒ Object
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
-
#service ⇒ Object
The gRPC service on which you want to perform the gRPC call.
-
#should_track_hops ⇒ Object
Turns on a traceroute probe to discover all gateways along the path to the host destination.
-
#timeout ⇒ Object
Timeout in seconds for the test.
-
#url ⇒ Object
URL to perform the test with.
Method Summary
Methods included from BaseGenericModel
Instance Attribute Details
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
116 117 118 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 116 def additional_properties @additional_properties end |
#allow_insecure ⇒ Object
Allows loading insecure content for an HTTP request in a multistep test step.
25 26 27 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 25 def allow_insecure @allow_insecure end |
#basic_auth ⇒ Object
Object to handle basic authentication when performing the test.
28 29 30 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 28 def basic_auth @basic_auth end |
#body ⇒ Object
Body to include in the test.
31 32 33 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 31 def body @body end |
#body_type ⇒ Object
Type of the request body.
34 35 36 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 34 def body_type @body_type end |
#call_type ⇒ Object
The type of gRPC call to perform.
37 38 39 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 37 def call_type @call_type end |
#certificate ⇒ Object
Client certificate to use when performing the test request.
40 41 42 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 40 def certificate @certificate end |
#certificate_domains ⇒ Object
By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in ‘certificateDomains`.
43 44 45 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 43 def certificate_domains @certificate_domains end |
#compressed_json_descriptor ⇒ Object
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
46 47 48 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 46 def compressed_json_descriptor @compressed_json_descriptor end |
#compressed_proto_file ⇒ Object
A protobuf file that needs to be gzipped first then base64 encoded.
49 50 51 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 49 def compressed_proto_file @compressed_proto_file end |
#dns_server ⇒ Object
DNS server to use for DNS tests.
52 53 54 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 52 def dns_server @dns_server end |
#dns_server_port ⇒ Object
DNS server port to use for DNS tests.
55 56 57 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 55 def dns_server_port @dns_server_port end |
#files ⇒ Object
Files to be used as part of the request in the test.
58 59 60 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 58 def files @files end |
#follow_redirects ⇒ Object
Specifies whether or not the request follows redirects.
61 62 63 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 61 def follow_redirects @follow_redirects end |
#headers ⇒ Object
Headers to include when performing the test.
64 65 66 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 64 def headers @headers end |
#host ⇒ Object
Host name to perform the test with.
67 68 69 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 67 def host @host end |
#http_version ⇒ Object
HTTP version to use for a Synthetic test.
70 71 72 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 70 def http_version @http_version end |
#message ⇒ Object
Message to send for UDP or WebSocket tests.
73 74 75 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 73 def @message end |
#metadata ⇒ Object
Metadata to include when performing the gRPC test.
76 77 78 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 76 def @metadata end |
#method ⇒ Object
Either the HTTP method/verb to use or a gRPC method available on the service set in the ‘service` field. Required if `subtype` is `HTTP` or if `subtype` is `grpc` and `callType` is `unary`.
79 80 81 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 79 def method @method end |
#no_saving_response_body ⇒ Object
Determines whether or not to save the response body.
82 83 84 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 82 def no_saving_response_body @no_saving_response_body end |
#number_of_packets ⇒ Object
Number of pings to use per test.
85 86 87 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 85 def number_of_packets @number_of_packets end |
#persist_cookies ⇒ Object
Persist cookies across redirects.
88 89 90 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 88 def @persist_cookies end |
#port ⇒ Object
Port to use when performing the test.
91 92 93 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 91 def port @port end |
#proxy ⇒ Object
The proxy to perform the test.
94 95 96 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 94 def proxy @proxy end |
#query ⇒ Object
Query to use for the test.
97 98 99 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 97 def query @query end |
#servername ⇒ Object
For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.
102 103 104 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 102 def servername @servername end |
#service ⇒ Object
The gRPC service on which you want to perform the gRPC call.
105 106 107 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 105 def service @service end |
#should_track_hops ⇒ Object
Turns on a traceroute probe to discover all gateways along the path to the host destination.
108 109 110 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 108 def should_track_hops @should_track_hops end |
#timeout ⇒ Object
Timeout in seconds for the test.
111 112 113 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 111 def timeout @timeout end |
#url ⇒ Object
URL to perform the test with.
114 115 116 |
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 114 def url @url end |