class DatadogAPIClient::V1::SyntheticsStepDetail

Object describing a step for a Synthetic test.

Attributes

browser_errors[RW]

Array of errors collected for a browser test.

check_type[RW]
description[RW]

Description of the test.

duration[RW]

Total duration in millisecond of the test.

error[RW]

Error returned by the test.

playing_tab[RW]
screenshot_bucket_key[RW]

Whether or not screenshots where collected by the test.

skipped[RW]

Whether or not to skip this step.

snapshot_bucket_key[RW]

Whether or not snapshots where collected by the test.

step_id[RW]

The step ID.

sub_test_step_details[RW]

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

time_to_interactive[RW]

Time before starting the step.

type[RW]
url[RW]

URL to perform the step against.

value[RW]

Value for the step.

vitals_metrics[RW]

Array of Core Web Vitals metrics for the step.

warnings[RW]

Warning collected that didn't failed the step.

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_step_detail.rb, line 94
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_step_detail.rb, line 71
def self.attribute_map
  {
    :'browser_errors' => :'browserErrors',
    :'check_type' => :'checkType',
    :'description' => :'description',
    :'duration' => :'duration',
    :'error' => :'error',
    :'playing_tab' => :'playingTab',
    :'screenshot_bucket_key' => :'screenshotBucketKey',
    :'skipped' => :'skipped',
    :'snapshot_bucket_key' => :'snapshotBucketKey',
    :'step_id' => :'stepId',
    :'sub_test_step_details' => :'subTestStepDetails',
    :'time_to_interactive' => :'timeToInteractive',
    :'type' => :'type',
    :'url' => :'url',
    :'value' => :'value',
    :'vitals_metrics' => :'vitalsMetrics',
    :'warnings' => :'warnings'
  }
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_step_detail.rb, line 271
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_step_detail.rb, line 129
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
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/datadog_api_client/v1/models/synthetics_step_detail.rb, line 99
def self.openapi_types
  {
    :'browser_errors' => :'Array<SyntheticsBrowserError>',
    :'check_type' => :'SyntheticsCheckType',
    :'description' => :'String',
    :'duration' => :'Float',
    :'error' => :'String',
    :'playing_tab' => :'SyntheticsPlayingTab',
    :'screenshot_bucket_key' => :'Boolean',
    :'skipped' => :'Boolean',
    :'snapshot_bucket_key' => :'Boolean',
    :'step_id' => :'Integer',
    :'sub_test_step_details' => :'Array<SyntheticsStepDetail>',
    :'time_to_interactive' => :'Float',
    :'type' => :'SyntheticsStepType',
    :'url' => :'String',
    :'value' => :'Object',
    :'vitals_metrics' => :'Array<SyntheticsCoreWebVitals>',
    :'warnings' => :'Array<SyntheticsStepDetailWarning>'
  }
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_step_detail.rb, line 234
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      browser_errors == o.browser_errors &&
      check_type == o.check_type &&
      description == o.description &&
      duration == o.duration &&
      error == o.error &&
      playing_tab == o.playing_tab &&
      screenshot_bucket_key == o.screenshot_bucket_key &&
      skipped == o.skipped &&
      snapshot_bucket_key == o.snapshot_bucket_key &&
      step_id == o.step_id &&
      sub_test_step_details == o.sub_test_step_details &&
      time_to_interactive == o.time_to_interactive &&
      type == o.type &&
      url == o.url &&
      value == o.value &&
      vitals_metrics == o.vitals_metrics &&
      warnings == o.warnings
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_step_detail.rb, line 301
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_step_detail.rb, line 375
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_step_detail.rb, line 278
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_step_detail.rb, line 258
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_step_detail.rb, line 264
def hash
  [browser_errors, check_type, description, duration, error, playing_tab, screenshot_bucket_key, skipped, snapshot_bucket_key, step_id, sub_test_step_details, time_to_interactive, type, url, value, vitals_metrics, warnings].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_step_detail.rb, line 221
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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_step_detail.rb, line 351
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_step_detail.rb, line 357
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_step_detail.rb, line 345
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_step_detail.rb, line 228
def valid?
  true
end