Class: DatadogAPIClient::V2::SyntheticsTestOptions

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/synthetics_test_options.rb

Overview

Object describing the extra options for a Synthetic test.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#_retry ⇒ Object

Object describing the retry strategy to apply to a Synthetic test.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 45

def _retry
  @_retry
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



53
54
55
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 53

def additional_properties
  @additional_properties
end

#min_failure_duration ⇒ Object

Minimum amount of time in failure required to trigger an alert.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 25

def min_failure_duration
  @min_failure_duration
end

#min_location_failed ⇒ Object

Minimum number of locations in failure required to trigger an alert.



29
30
31
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 29

def min_location_failed
  @min_location_failed
end

#monitor_name ⇒ Object

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.



32
33
34
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 32

def monitor_name
  @monitor_name
end

#monitor_options ⇒ Object

Object containing the options for a Synthetic test as a monitor (for example, renotification).



36
37
38
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 36

def monitor_options
  @monitor_options
end

#monitor_priority ⇒ Object

Integer from 1 (high) to 5 (low) indicating alert severity.



39
40
41
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 39

def monitor_priority
  @monitor_priority
end

#restricted_roles ⇒ Object

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 42

def restricted_roles
  @restricted_roles
end

#scheduling ⇒ Object

Object containing timeframes and timezone used for advanced scheduling.



48
49
50
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 48

def scheduling
  @scheduling
end

#tick_every ⇒ Object

The frequency at which to run the Synthetic test (in seconds).



51
52
53
 
# File 'lib/datadog_api_client/v2/models/synthetics_test_options.rb', line 51

def tick_every
  @tick_every
end