Class: DatadogAPIClient::V1::SyntheticsStepDetail

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

Overview

Object describing a step for a Synthetic test.

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_step_detail.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#allow_failure ⇒ Object

Whether or not the step was allowed to fail.



25
26
27
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 25

def allow_failure
  @allow_failure
end

#browser_errors ⇒ Object

Array of errors collected for a browser test.



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

def browser_errors
  @browser_errors
end

#check_type ⇒ Object

Type of assertion to apply in an API test.



31
32
33
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 31

def check_type
  @check_type
end

#description ⇒ Object

Description of the test.



31
32
33
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 31

def description
  @description
end

#duration ⇒ Object

Total duration in millisecond of the test.



34
35
36
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 34

def duration
  @duration
end

#error ⇒ Object

Error returned by the test.



37
38
39
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 37

def error
  @error
end

#failure ⇒ Object

The browser test failure details.



43
44
45
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 43

def failure
  @failure
end

#playing_tab ⇒ Object

Navigate between different tabs for your browser test.



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

def playing_tab
  @playing_tab
end

#screenshot_bucket_key ⇒ Object

Whether or not screenshots where collected by the test.



42
43
44
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 42

def screenshot_bucket_key
  @screenshot_bucket_key
end

#skipped ⇒ Object

Whether or not to skip this step.



45
46
47
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 45

def skipped
  @skipped
end

#snapshot_bucket_key ⇒ Object

Whether or not snapshots where collected by the test.



48
49
50
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 48

def snapshot_bucket_key
  @snapshot_bucket_key
end

#step_id ⇒ Object

The step ID.



51
52
53
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 51

def step_id
  @step_id
end

#sub_test_step_details ⇒ Object

If this step includes a sub-test. Subtests documentation.



54
55
56
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 54

def sub_test_step_details
  @sub_test_step_details
end

#time_to_interactive ⇒ Object

Time before starting the step.



57
58
59
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 57

def time_to_interactive
  @time_to_interactive
end

#type ⇒ Object

Step type used in your Synthetic test.



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

def type
  @type
end

#url ⇒ Object

URL to perform the step against.



62
63
64
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 62

def url
  @url
end

#value ⇒ Object

Value for the step.



65
66
67
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 65

def value
  @value
end

#vitals_metrics ⇒ Object

Array of Core Web Vitals metrics for the step.



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

def vitals_metrics
  @vitals_metrics
end

#warnings ⇒ Object

Warning collected that didn't failed the step.



71
72
73
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 71

def warnings
  @warnings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

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



275
276
277
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 275

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
129
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 125

def self.openapi_nullable
  Set.new([
    :'value',
  ])
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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 305

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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 383

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 282

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


262
263
264
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 262

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



225
226
227
228
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 225

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



359
360
361
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 359

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



353
354
355
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 353

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



232
233
234
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 232

def valid?
  true
end