class DatadogAPIClient::V1::SyntheticsTestRequest

Object describing the Synthetic test request.

Attributes

allow_insecure[RW]

Allows loading insecure content for an HTTP request in a multistep test step.

basic_auth[RW]
body[RW]

Body to include in the test.

certificate[RW]
dns_server[RW]

DNS server to use for DNS tests.

dns_server_port[RW]

DNS server port to use for DNS tests.

headers[RW]

Headers to include when performing the test.

host[RW]

Host name to perform the test with.

method[RW]
no_saving_response_body[RW]

Determines whether or not to save the response body.

number_of_packets[RW]

Number of pings to use per test.

port[RW]

Port to use when performing the test.

query[RW]

Query to use for the test.

should_track_hops[RW]

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

timeout[RW]

Timeout in seconds for the test.

url[RW]

URL to perform the test with.

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_request.rb, line 90
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_request.rb, line 68
def self.attribute_map
  {
    :'allow_insecure' => :'allow_insecure',
    :'basic_auth' => :'basicAuth',
    :'body' => :'body',
    :'certificate' => :'certificate',
    :'dns_server' => :'dnsServer',
    :'dns_server_port' => :'dnsServerPort',
    :'headers' => :'headers',
    :'host' => :'host',
    :'method' => :'method',
    :'no_saving_response_body' => :'noSavingResponseBody',
    :'number_of_packets' => :'numberOfPackets',
    :'port' => :'port',
    :'query' => :'query',
    :'should_track_hops' => :'shouldTrackHops',
    :'timeout' => :'timeout',
    :'url' => :'url'
  }
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_request.rb, line 303
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_request.rb, line 124
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::SyntheticsTestRequest` 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::SyntheticsTestRequest`. 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?(:'allow_insecure')
    self.allow_insecure = attributes[:'allow_insecure']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/datadog_api_client/v1/models/synthetics_test_request.rb, line 117
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_request.rb, line 95
def self.openapi_types
  {
    :'allow_insecure' => :'Boolean',
    :'basic_auth' => :'SyntheticsBasicAuth',
    :'body' => :'String',
    :'certificate' => :'SyntheticsTestRequestCertificate',
    :'dns_server' => :'String',
    :'dns_server_port' => :'Integer',
    :'headers' => :'Hash<String, String>',
    :'host' => :'String',
    :'method' => :'HTTPMethod',
    :'no_saving_response_body' => :'Boolean',
    :'number_of_packets' => :'Integer',
    :'port' => :'Integer',
    :'query' => :'Object',
    :'should_track_hops' => :'Boolean',
    :'timeout' => :'Float',
    :'url' => :'String'
  }
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_request.rb, line 267
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_insecure == o.allow_insecure &&
      basic_auth == o.basic_auth &&
      body == o.body &&
      certificate == o.certificate &&
      dns_server == o.dns_server &&
      dns_server_port == o.dns_server_port &&
      headers == o.headers &&
      host == o.host &&
      method == o.method &&
      no_saving_response_body == o.no_saving_response_body &&
      number_of_packets == o.number_of_packets &&
      port == o.port &&
      query == o.query &&
      should_track_hops == o.should_track_hops &&
      timeout == o.timeout &&
      url == o.url
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_request.rb, line 333
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_request.rb, line 407
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_request.rb, line 310
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
dns_server_port=(dns_server_port) click to toggle source

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

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

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

  @dns_server_port = dns_server_port
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_request.rb, line 290
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_request.rb, line 296
def hash
  [allow_insecure, basic_auth, body, certificate, dns_server, dns_server_port, headers, host, method, no_saving_response_body, number_of_packets, port, query, should_track_hops, timeout, url].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_request.rb, line 206
def list_invalid_properties
  invalid_properties = Array.new
  if !@dns_server_port.nil? && @dns_server_port > 65535
    invalid_properties.push('invalid value for "dns_server_port", must be smaller than or equal to 65535.')
  end

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

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

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

  invalid_properties
end
number_of_packets=(number_of_packets) click to toggle source

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

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

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

  @number_of_packets = number_of_packets
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_request.rb, line 383
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_request.rb, line 389
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_request.rb, line 377
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_request.rb, line 229
def valid?
  return false if !@dns_server_port.nil? && @dns_server_port > 65535
  return false if !@dns_server_port.nil? && @dns_server_port < 1
  return false if !@number_of_packets.nil? && @number_of_packets > 10
  return false if !@number_of_packets.nil? && @number_of_packets < 0
  true
end