Class: DatadogAPIClient::V1::SyntheticsTiming

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/synthetics_timing.rb,
lib/datadog_api_client/v1/models/synthetics_timing.rb

Overview

Object containing all metrics and their values collected for a Synthetic API test. See the Synthetic Monitoring Metrics documentation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 23

def _unparsed
  @_unparsed
end

#dns ⇒ Object

The duration in millisecond of the DNS lookup.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 26

def dns
  @dns
end

#download ⇒ Object

The time in millisecond to download the response.



29
30
31
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 29

def download
  @download
end

#first_byte ⇒ Object

The time in millisecond to first byte.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 32

def first_byte
  @first_byte
end

#handshake ⇒ Object

The duration in millisecond of the TLS handshake.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 35

def handshake
  @handshake
end

#redirect ⇒ Object

The time in millisecond spent during redirections.



38
39
40
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 38

def redirect
  @redirect
end

#ssl ⇒ Object

The duration in millisecond of the TLS handshake.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 41

def ssl
  @ssl
end

#tcp ⇒ Object

Time in millisecond to establish the TCP connection.



44
45
46
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 44

def tcp
  @tcp
end

#total ⇒ Object

The overall time in millisecond the request took to be processed.



47
48
49
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 47

def total
  @total
end

#wait ⇒ Object

Time spent in millisecond waiting for a response.



50
51
52
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 50

def wait
  @wait
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



189
190
191
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 189

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

Instance Method Details

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 219

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)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 297

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 196

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 176

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



147
148
149
150
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 147

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 273

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 279

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



267
268
269
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 267

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



154
155
156
 
# File 'lib/datadog_api_client/v1/models/synthetics_timing.rb', line 154

def valid?
  true
end