class DatadogAPIClient::V1::SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Attributes

_retry[RW]
accept_self_signed[RW]

For SSL test, whether or not the test should allow self signed certificates.

allow_insecure[RW]

Allows loading insecure content for an HTTP request.

device_ids[RW]

For browser test, array with the different device IDs used to run the test.

disable_cors[RW]

Whether or not to disable CORS mechanism.

follow_redirects[RW]

For API HTTP test, whether or not the test should follow redirects.

min_failure_duration[RW]

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

min_location_failed[RW]

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

monitor_name[RW]

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

monitor_options[RW]
monitor_priority[RW]

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

no_screenshot[RW]

Prevents saving screenshots of the steps.

tick_every[RW]

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

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 79
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 60
def self.attribute_map
  {
    :'accept_self_signed' => :'accept_self_signed',
    :'allow_insecure' => :'allow_insecure',
    :'device_ids' => :'device_ids',
    :'disable_cors' => :'disableCors',
    :'follow_redirects' => :'follow_redirects',
    :'min_failure_duration' => :'min_failure_duration',
    :'min_location_failed' => :'min_location_failed',
    :'monitor_name' => :'monitor_name',
    :'monitor_options' => :'monitor_options',
    :'monitor_priority' => :'monitor_priority',
    :'no_screenshot' => :'noScreenshot',
    :'_retry' => :'retry',
    :'tick_every' => :'tick_every'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 274
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 110
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::SyntheticsTestOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V1::SyntheticsTestOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'accept_self_signed')
    self.accept_self_signed = attributes[:'accept_self_signed']
  end

  if attributes.key?(:'allow_insecure')
    self.allow_insecure = attributes[:'allow_insecure']
  end

  if attributes.key?(:'device_ids')
    if (value = attributes[:'device_ids']).is_a?(Array)
      self.device_ids = value
    end
  end

  if attributes.key?(:'disable_cors')
    self.disable_cors = attributes[:'disable_cors']
  end

  if attributes.key?(:'follow_redirects')
    self.follow_redirects = attributes[:'follow_redirects']
  end

  if attributes.key?(:'min_failure_duration')
    self.min_failure_duration = attributes[:'min_failure_duration']
  end

  if attributes.key?(:'min_location_failed')
    self.min_location_failed = attributes[:'min_location_failed']
  end

  if attributes.key?(:'monitor_name')
    self.monitor_name = attributes[:'monitor_name']
  end

  if attributes.key?(:'monitor_options')
    self.monitor_options = attributes[:'monitor_options']
  end

  if attributes.key?(:'monitor_priority')
    self.monitor_priority = attributes[:'monitor_priority']
  end

  if attributes.key?(:'no_screenshot')
    self.no_screenshot = attributes[:'no_screenshot']
  end

  if attributes.key?(:'_retry')
    self._retry = attributes[:'_retry']
  end

  if attributes.key?(:'tick_every')
    self.tick_every = attributes[:'tick_every']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 103
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 84
def self.openapi_types
  {
    :'accept_self_signed' => :'Boolean',
    :'allow_insecure' => :'Boolean',
    :'device_ids' => :'Array<SyntheticsDeviceID>',
    :'disable_cors' => :'Boolean',
    :'follow_redirects' => :'Boolean',
    :'min_failure_duration' => :'Integer',
    :'min_location_failed' => :'Integer',
    :'monitor_name' => :'String',
    :'monitor_options' => :'SyntheticsTestOptionsMonitorOptions',
    :'monitor_priority' => :'Integer',
    :'no_screenshot' => :'Boolean',
    :'_retry' => :'SyntheticsTestOptionsRetry',
    :'tick_every' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 241
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accept_self_signed == o.accept_self_signed &&
      allow_insecure == o.allow_insecure &&
      device_ids == o.device_ids &&
      disable_cors == o.disable_cors &&
      follow_redirects == o.follow_redirects &&
      min_failure_duration == o.min_failure_duration &&
      min_location_failed == o.min_location_failed &&
      monitor_name == o.monitor_name &&
      monitor_options == o.monitor_options &&
      monitor_priority == o.monitor_priority &&
      no_screenshot == o.no_screenshot &&
      _retry == o._retry &&
      tick_every == o.tick_every
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 304
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when :Array
    # generic array, return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = DatadogAPIClient::V1.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 378
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 281
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 261
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 267
def hash
  [accept_self_signed, allow_insecure, device_ids, disable_cors, follow_redirects, min_failure_duration, min_location_failed, monitor_name, monitor_options, monitor_priority, no_screenshot, _retry, tick_every].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 180
def list_invalid_properties
  invalid_properties = Array.new
  if !@monitor_priority.nil? && @monitor_priority > 5
    invalid_properties.push('invalid value for "monitor_priority", must be smaller than or equal to 5.')
  end

  if !@monitor_priority.nil? && @monitor_priority < 1
    invalid_properties.push('invalid value for "monitor_priority", must be greater than or equal to 1.')
  end

  if !@tick_every.nil? && @tick_every > 604800
    invalid_properties.push('invalid value for "tick_every", must be smaller than or equal to 604800.')
  end

  if !@tick_every.nil? && @tick_every < 30
    invalid_properties.push('invalid value for "tick_every", must be greater than or equal to 30.')
  end

  invalid_properties
end
monitor_priority=(monitor_priority) click to toggle source

Custom attribute writer method with validation @param [Object] monitor_priority Value to be assigned

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 213
def monitor_priority=(monitor_priority)
  if !monitor_priority.nil? && monitor_priority > 5
    fail ArgumentError, 'invalid value for "monitor_priority", must be smaller than or equal to 5.'
  end

  if !monitor_priority.nil? && monitor_priority < 1
    fail ArgumentError, 'invalid value for "monitor_priority", must be greater than or equal to 1.'
  end

  @monitor_priority = monitor_priority
end
tick_every=(tick_every) click to toggle source

Custom attribute writer method with validation @param [Object] tick_every Value to be assigned

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 227
def tick_every=(tick_every)
  if !tick_every.nil? && tick_every > 604800
    fail ArgumentError, 'invalid value for "tick_every", must be smaller than or equal to 604800.'
  end

  if !tick_every.nil? && tick_every < 30
    fail ArgumentError, 'invalid value for "tick_every", must be greater than or equal to 30.'
  end

  @tick_every = tick_every
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 354
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 360
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 348
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/datadog_api_client/v1/models/synthetics_test_options.rb, line 203
def valid?
  return false if !@monitor_priority.nil? && @monitor_priority > 5
  return false if !@monitor_priority.nil? && @monitor_priority < 1
  return false if !@tick_every.nil? && @tick_every > 604800
  return false if !@tick_every.nil? && @tick_every < 30
  true
end