Class: DatadogAPIClient::V1::SyntheticsTestRequest

Inherits:
Object
  • Object
show all
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

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



139
140
141
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 139

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 call to perform. Used by gRPC steps (healthcheck, unary) and MCP steps (init, tool_list, tool_call). Valid values depend on the parent step's subtype.



39
40
41
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 39

def call_type
  @call_type
end

#certificate ⇒ Object

Client certificate to use when performing the test request.



42
43
44
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 42

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.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 45

def certificate_domains
  @certificate_domains
end

#check_certificate_revocation ⇒ Object

Check for certificate revocation.



48
49
50
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 48

def check_certificate_revocation
  @check_certificate_revocation
end

#compressed_json_descriptor ⇒ Object

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 51

def compressed_json_descriptor
  @compressed_json_descriptor
end

#compressed_proto_file ⇒ Object

A protobuf file that needs to be gzipped first then base64 encoded.



54
55
56
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 54

def compressed_proto_file
  @compressed_proto_file
end

#disable_aia_intermediate_fetching ⇒ Object

Disable fetching intermediate certificates from AIA.



57
58
59
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 57

def disable_aia_intermediate_fetching
  @disable_aia_intermediate_fetching
end

#dns_server ⇒ Object

DNS server to use for DNS tests.



60
61
62
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 60

def dns_server
  @dns_server
end

#dns_server_port ⇒ Object

DNS server port to use for DNS tests.



63
64
65
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 63

def dns_server_port
  @dns_server_port
end

#files ⇒ Object

Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.



66
67
68
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 66

def files
  @files
end

#follow_redirects ⇒ Object

Specifies whether or not the request follows redirects.



69
70
71
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 69

def follow_redirects
  @follow_redirects
end

#form ⇒ Object

Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.



72
73
74
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 72

def form
  @form
end

#headers ⇒ Object

Headers to include when performing the test.



75
76
77
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 75

def headers
  @headers
end

#host ⇒ Object

Host name to perform the test with.



78
79
80
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 78

def host
  @host
end

#http_version ⇒ Object

HTTP version to use for a Synthetic test.



81
82
83
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 81

def http_version
  @http_version
end

#is_message_base64_encoded ⇒ Object

Whether the message is base64 encoded.



84
85
86
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 84

def is_message_base64_encoded
  @is_message_base64_encoded
end

#mcp_protocol_version ⇒ Object

The MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.



87
88
89
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 87

def mcp_protocol_version
  @mcp_protocol_version
end

#message ⇒ Object

Message to send for UDP or WebSocket tests.



90
91
92
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 90

def message
  @message
end

#metadata ⇒ Object

Metadata to include when performing the gRPC test.



93
94
95
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 93

def metadata
  @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.



96
97
98
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 96

def method
  @method
end

#no_saving_response_body ⇒ Object

Determines whether or not to save the response body.



99
100
101
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 99

def no_saving_response_body
  @no_saving_response_body
end

#number_of_packets ⇒ Object

Number of pings to use per test.



102
103
104
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 102

def number_of_packets
  @number_of_packets
end

#persist_cookies ⇒ Object

Persist cookies across redirects.



105
106
107
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 105

def persist_cookies
  @persist_cookies
end

#port ⇒ Object

Port to use when performing the test.



108
109
110
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 108

def port
  @port
end

#proxy ⇒ Object

The proxy to perform the test.



111
112
113
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 111

def proxy
  @proxy
end

#query ⇒ Object

Query to use for the test.



114
115
116
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 114

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.



119
120
121
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 119

def servername
  @servername
end

#service ⇒ Object

The gRPC service on which you want to perform the gRPC call.



122
123
124
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 122

def service
  @service
end

#should_track_hops ⇒ Object

Turns on a traceroute probe to discover all gateways along the path to the host destination.



125
126
127
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 125

def should_track_hops
  @should_track_hops
end

#timeout ⇒ Object

Timeout in seconds for the test.



128
129
130
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 128

def timeout
  @timeout
end

#tool_args ⇒ Object

Arguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.



131
132
133
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 131

def tool_args
  @tool_args
end

#tool_name ⇒ Object

The name of the MCP tool to call. Required when callType is tool_call.



134
135
136
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 134

def tool_name
  @tool_name
end

#url ⇒ Object

URL to perform the test with.



137
138
139
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 137

def url
  @url
end