Class: DatadogAPIClient::V1::SyntheticsStepDetail

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SyntheticsStepDetail

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attributes Model attributes in the form of hash



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 138

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::SyntheticsStepDetail` 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::SyntheticsStepDetail`. 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?(:'browser_errors')
    if (value = attributes[:'browser_errors']).is_a?(Array)
      self.browser_errors = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#browser_errors ⇒ Object

Array of errors collected for a browser test.



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

def browser_errors
  @browser_errors
end

#check_type ⇒ Object

Returns the value of attribute check_type.



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

def check_type
  @check_type
end

#description ⇒ Object

Description of the test.



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

def description
  @description
end

#duration ⇒ Object

Total duration in millisecond of the test.



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

def duration
  @duration
end

#error ⇒ Object

Error returned by the test.



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

def error
  @error
end

#playing_tab ⇒ Object

Returns the value of attribute playing_tab.



40
41
42
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 40

def playing_tab
  @playing_tab
end

#screenshot_bucket_key ⇒ Object

Whether or not screenshots where collected by the test.



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

def screenshot_bucket_key
  @screenshot_bucket_key
end

#skipped ⇒ Object

Whether or not to skip this step.



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

def skipped
  @skipped
end

#snapshot_bucket_key ⇒ Object

Whether or not snapshots where collected by the test.



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

def snapshot_bucket_key
  @snapshot_bucket_key
end

#step_id ⇒ Object

The step ID.



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

def step_id
  @step_id
end

#sub_test_step_details ⇒ Object

If this steps include a sub-test. [Subtests documentation](docs.datadoghq.com/synthetics/browser_tests/advanced_options/#subtests).



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

def sub_test_step_details
  @sub_test_step_details
end

#time_to_interactive ⇒ Object

Time before starting the step.



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

def time_to_interactive
  @time_to_interactive
end

#type ⇒ Object

Returns the value of attribute type.



60
61
62
 
# File 'lib/datadog_api_client/v1/models/synthetics_step_detail.rb', line 60

def type
  @type
end

#url ⇒ Object

URL to perform the step against.



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

def url
  @url
end

#value ⇒ Object

Value for the step.



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

def value
  @value
end

#vitals_metrics ⇒ Object

Array of Core Web Vitals metrics for the step.



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

def vitals_metrics
  @vitals_metrics
end

#warnings ⇒ Object

Warning collected that didn’t failed the step.



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

def warnings
  @warnings
end