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.



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

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

#check_certificate_revocation ⇒ Object

Check for certificate revocation.



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

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.



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

def compressed_json_descriptor
  @compressed_json_descriptor
end

#compressed_proto_file ⇒ Object

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



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

def compressed_proto_file
  @compressed_proto_file
end

#dns_server ⇒ Object

DNS server to use for DNS tests.



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

def dns_server
  @dns_server
end

#dns_server_port ⇒ Object

DNS server port to use for DNS tests.



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

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`.



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

def files
  @files
end

#follow_redirects ⇒ Object

Specifies whether or not the request follows redirects.



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

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`.



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

def form
  @form
end

#headers ⇒ Object

Headers to include when performing the test.



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

def headers
  @headers
end

#host ⇒ Object

Host name to perform the test with.



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

def host
  @host
end

#http_version ⇒ Object

HTTP version to use for a Synthetic test.



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

def http_version
  @http_version
end

#is_message_base64_encoded ⇒ Object

Whether the message is base64 encoded.



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

def is_message_base64_encoded
  @is_message_base64_encoded
end

#message ⇒ Object

Message to send for UDP or WebSocket tests.



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

def message
  @message
end

#metadata ⇒ Object

Metadata to include when performing the gRPC test.



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

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`.



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

def method
  @method
end

#no_saving_response_body ⇒ Object

Determines whether or not to save the response body.



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

def no_saving_response_body
  @no_saving_response_body
end

#number_of_packets ⇒ Object

Number of pings to use per test.



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

def number_of_packets
  @number_of_packets
end

#persist_cookies ⇒ Object

Persist cookies across redirects.



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

def persist_cookies
  @persist_cookies
end

#port ⇒ Object

Port to use when performing the test.



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

def port
  @port
end

#proxy ⇒ Object

The proxy to perform the test.



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

def proxy
  @proxy
end

#query ⇒ Object

Query to use for the test.



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

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.



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

def servername
  @servername
end

#service ⇒ Object

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



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

def service
  @service
end

#should_track_hops ⇒ Object

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



117
118
119
 
# File 'lib/datadog_api_client/v1/models/synthetics_test_request.rb', line 117

def should_track_hops
  @should_track_hops
end

#timeout ⇒ Object

Timeout in seconds for the test.



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

def timeout
  @timeout
end

#url ⇒ Object

URL to perform the test with.



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

def url
  @url
end