datadog_api_client 2.52.0 → 2.53.0

data/lib/datadog_api_client/v2/models/synthetics_test_result_step.rb

@@ -0,0 +1,543 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # A step result from a browser, mobile, or multistep API test.
+  class SyntheticsTestResultStep
+    include BaseGenericModel
+
+    # Whether the test continues when this step fails.
+    attr_accessor :allow_failure
+
+    # Inner API test definition for browser `runApiTest` steps.
+    attr_accessor :api_test
+
+    # Assertion result for a browser or mobile step.
+    attr_accessor :assertion_result
+
+    # Assertion results produced by the step.
+    attr_accessor :assertions
+
+    # URLs of requests blocked during the step.
+    attr_accessor :blocked_requests_urls
+
+    # Bounding box of an element on the page.
+    attr_accessor :bounds
+
+    # Browser errors captured during the step.
+    attr_accessor :browser_errors
+
+    # Storage bucket keys for artifacts produced during a step or test.
+    attr_accessor :bucket_keys
+
+    # CDN resources encountered during the step.
+    attr_accessor :cdn_resources
+
+    # Click type performed in a browser step.
+    attr_accessor :click_type
+
+    # Compressed JSON descriptor for the step (internal format).
+    attr_accessor :compressed_json_descriptor
+
+    # Request configuration executed by this step (API test steps).
+    attr_accessor :config
+
+    # Human-readable description of the step.
+    attr_accessor :description
+
+    # Duration of the step in milliseconds.
+    attr_accessor :duration
+
+    # Description of the element interacted with by the step.
+    attr_accessor :element_description
+
+    # Element locator updates produced during a step.
+    attr_accessor :element_updates
+
+    # A variable used or extracted during a test.
+    attr_accessor :extracted_value
+
+    # Details about the failure of a Synthetic test.
+    attr_accessor :failure
+
+    # HTTP results produced by an MCP step.
+    attr_accessor :http_results
+
+    # Identifier of the step.
+    attr_accessor :id
+
+    # Whether this step is critical for the test outcome.
+    attr_accessor :is_critical
+
+    # Whether the step uses a custom JavaScript assertion.
+    attr_accessor :javascript_custom_assertion_code
+
+    # Time taken to locate the element in milliseconds.
+    attr_accessor :locate_element_duration
+
+    # Name of the step.
+    attr_accessor :name
+
+    # Details of the outgoing request made during the test execution.
+    attr_accessor :request
+
+    # Details of the response received during the test execution.
+    attr_accessor :response
+
+    # Retry results for the step.
+    attr_accessor :retries
+
+    # Number of times this step was retried.
+    attr_accessor :retry_count
+
+    # RUM application context associated with a step or sub-test.
+    attr_accessor :rum_context
+
+    # Unix timestamp (ms) of when the step started.
+    attr_accessor :started_at
+
+    # Status of the step (for example, `passed`, `failed`).
+    attr_accessor :status
+
+    # Information about a sub-step in a nested test execution.
+    attr_accessor :sub_step
+
+    # Information about a sub-test played from a parent browser test.
+    attr_accessor :sub_test
+
+    # Subtype of the step.
+    attr_accessor :subtype
+
+    # Browser tabs involved in the step.
+    attr_accessor :tabs
+
+    # Timing breakdown of the step execution.
+    attr_accessor :timings
+
+    # Whether the step was executed through a Synthetics tunnel.
+    attr_accessor :tunnel
+
+    # Type of the step (for example, `click`, `assertElementContent`, `runApiTest`).
+    attr_accessor :type
+
+    # URL associated with the step (for navigation steps).
+    attr_accessor :url
+
+    # Step value. Its type depends on the step type.
+    attr_accessor :value
+
+    # Variables captured during a test step.
+    attr_accessor :variables
+
+    # Web vitals metrics captured during the step.
+    attr_accessor :vitals_metrics
+
+    # Warnings emitted during the step.
+    attr_accessor :warnings
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'allow_failure' => :'allow_failure',
+        :'api_test' => :'api_test',
+        :'assertion_result' => :'assertion_result',
+        :'assertions' => :'assertions',
+        :'blocked_requests_urls' => :'blocked_requests_urls',
+        :'bounds' => :'bounds',
+        :'browser_errors' => :'browser_errors',
+        :'bucket_keys' => :'bucket_keys',
+        :'cdn_resources' => :'cdn_resources',
+        :'click_type' => :'click_type',
+        :'compressed_json_descriptor' => :'compressed_json_descriptor',
+        :'config' => :'config',
+        :'description' => :'description',
+        :'duration' => :'duration',
+        :'element_description' => :'element_description',
+        :'element_updates' => :'element_updates',
+        :'extracted_value' => :'extracted_value',
+        :'failure' => :'failure',
+        :'http_results' => :'http_results',
+        :'id' => :'id',
+        :'is_critical' => :'is_critical',
+        :'javascript_custom_assertion_code' => :'javascript_custom_assertion_code',
+        :'locate_element_duration' => :'locate_element_duration',
+        :'name' => :'name',
+        :'request' => :'request',
+        :'response' => :'response',
+        :'retries' => :'retries',
+        :'retry_count' => :'retry_count',
+        :'rum_context' => :'rum_context',
+        :'started_at' => :'started_at',
+        :'status' => :'status',
+        :'sub_step' => :'sub_step',
+        :'sub_test' => :'sub_test',
+        :'subtype' => :'subtype',
+        :'tabs' => :'tabs',
+        :'timings' => :'timings',
+        :'tunnel' => :'tunnel',
+        :'type' => :'type',
+        :'url' => :'url',
+        :'value' => :'value',
+        :'variables' => :'variables',
+        :'vitals_metrics' => :'vitals_metrics',
+        :'warnings' => :'warnings'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'allow_failure' => :'Boolean',
+        :'api_test' => :'Hash<String, Object>',
+        :'assertion_result' => :'SyntheticsTestResultStepAssertionResult',
+        :'assertions' => :'Array<SyntheticsTestResultAssertionResult>',
+        :'blocked_requests_urls' => :'Array<String>',
+        :'bounds' => :'SyntheticsTestResultBounds',
+        :'browser_errors' => :'Array<SyntheticsTestResultBrowserError>',
+        :'bucket_keys' => :'SyntheticsTestResultBucketKeys',
+        :'cdn_resources' => :'Array<SyntheticsTestResultCdnResource>',
+        :'click_type' => :'String',
+        :'compressed_json_descriptor' => :'String',
+        :'config' => :'Hash<String, Object>',
+        :'description' => :'String',
+        :'duration' => :'Float',
+        :'element_description' => :'String',
+        :'element_updates' => :'SyntheticsTestResultStepElementUpdates',
+        :'extracted_value' => :'SyntheticsTestResultVariable',
+        :'failure' => :'SyntheticsTestResultFailure',
+        :'http_results' => :'Array<SyntheticsTestResultAssertionResult>',
+        :'id' => :'String',
+        :'is_critical' => :'Boolean',
+        :'javascript_custom_assertion_code' => :'Boolean',
+        :'locate_element_duration' => :'Float',
+        :'name' => :'String',
+        :'request' => :'SyntheticsTestResultRequestInfo',
+        :'response' => :'SyntheticsTestResultResponseInfo',
+        :'retries' => :'Array<SyntheticsTestResultStep>',
+        :'retry_count' => :'Integer',
+        :'rum_context' => :'SyntheticsTestResultRumContext',
+        :'started_at' => :'Integer',
+        :'status' => :'String',
+        :'sub_step' => :'SyntheticsTestResultSubStep',
+        :'sub_test' => :'SyntheticsTestResultSubTest',
+        :'subtype' => :'String',
+        :'tabs' => :'Array<SyntheticsTestResultTab>',
+        :'timings' => :'Hash<String, Object>',
+        :'tunnel' => :'Boolean',
+        :'type' => :'String',
+        :'url' => :'String',
+        :'value' => :'Object',
+        :'variables' => :'SyntheticsTestResultVariables',
+        :'vitals_metrics' => :'Array<SyntheticsTestResultVitalsMetrics>',
+        :'warnings' => :'Array<SyntheticsTestResultWarning>'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::SyntheticsTestResultStep` initialize method"
+      end
+
+      self.additional_properties = {}
+      # 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))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'allow_failure')
+        self.allow_failure = attributes[:'allow_failure']
+      end
+
+      if attributes.key?(:'api_test')
+        self.api_test = attributes[:'api_test']
+      end
+
+      if attributes.key?(:'assertion_result')
+        self.assertion_result = attributes[:'assertion_result']
+      end
+
+      if attributes.key?(:'assertions')
+        if (value = attributes[:'assertions']).is_a?(Array)
+          self.assertions = value
+        end
+      end
+
+      if attributes.key?(:'blocked_requests_urls')
+        if (value = attributes[:'blocked_requests_urls']).is_a?(Array)
+          self.blocked_requests_urls = value
+        end
+      end
+
+      if attributes.key?(:'bounds')
+        self.bounds = attributes[:'bounds']
+      end
+
+      if attributes.key?(:'browser_errors')
+        if (value = attributes[:'browser_errors']).is_a?(Array)
+          self.browser_errors = value
+        end
+      end
+
+      if attributes.key?(:'bucket_keys')
+        self.bucket_keys = attributes[:'bucket_keys']
+      end
+
+      if attributes.key?(:'cdn_resources')
+        if (value = attributes[:'cdn_resources']).is_a?(Array)
+          self.cdn_resources = value
+        end
+      end
+
+      if attributes.key?(:'click_type')
+        self.click_type = attributes[:'click_type']
+      end
+
+      if attributes.key?(:'compressed_json_descriptor')
+        self.compressed_json_descriptor = attributes[:'compressed_json_descriptor']
+      end
+
+      if attributes.key?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'element_description')
+        self.element_description = attributes[:'element_description']
+      end
+
+      if attributes.key?(:'element_updates')
+        self.element_updates = attributes[:'element_updates']
+      end
+
+      if attributes.key?(:'extracted_value')
+        self.extracted_value = attributes[:'extracted_value']
+      end
+
+      if attributes.key?(:'failure')
+        self.failure = attributes[:'failure']
+      end
+
+      if attributes.key?(:'http_results')
+        if (value = attributes[:'http_results']).is_a?(Array)
+          self.http_results = value
+        end
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'is_critical')
+        self.is_critical = attributes[:'is_critical']
+      end
+
+      if attributes.key?(:'javascript_custom_assertion_code')
+        self.javascript_custom_assertion_code = attributes[:'javascript_custom_assertion_code']
+      end
+
+      if attributes.key?(:'locate_element_duration')
+        self.locate_element_duration = attributes[:'locate_element_duration']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'request')
+        self.request = attributes[:'request']
+      end
+
+      if attributes.key?(:'response')
+        self.response = attributes[:'response']
+      end
+
+      if attributes.key?(:'retries')
+        if (value = attributes[:'retries']).is_a?(Array)
+          self.retries = value
+        end
+      end
+
+      if attributes.key?(:'retry_count')
+        self.retry_count = attributes[:'retry_count']
+      end
+
+      if attributes.key?(:'rum_context')
+        self.rum_context = attributes[:'rum_context']
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'sub_step')
+        self.sub_step = attributes[:'sub_step']
+      end
+
+      if attributes.key?(:'sub_test')
+        self.sub_test = attributes[:'sub_test']
+      end
+
+      if attributes.key?(:'subtype')
+        self.subtype = attributes[:'subtype']
+      end
+
+      if attributes.key?(:'tabs')
+        if (value = attributes[:'tabs']).is_a?(Array)
+          self.tabs = value
+        end
+      end
+
+      if attributes.key?(:'timings')
+        self.timings = attributes[:'timings']
+      end
+
+      if attributes.key?(:'tunnel')
+        self.tunnel = attributes[:'tunnel']
+      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?(:'variables')
+        self.variables = attributes[:'variables']
+      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
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    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
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          allow_failure == o.allow_failure &&
+          api_test == o.api_test &&
+          assertion_result == o.assertion_result &&
+          assertions == o.assertions &&
+          blocked_requests_urls == o.blocked_requests_urls &&
+          bounds == o.bounds &&
+          browser_errors == o.browser_errors &&
+          bucket_keys == o.bucket_keys &&
+          cdn_resources == o.cdn_resources &&
+          click_type == o.click_type &&
+          compressed_json_descriptor == o.compressed_json_descriptor &&
+          config == o.config &&
+          description == o.description &&
+          duration == o.duration &&
+          element_description == o.element_description &&
+          element_updates == o.element_updates &&
+          extracted_value == o.extracted_value &&
+          failure == o.failure &&
+          http_results == o.http_results &&
+          id == o.id &&
+          is_critical == o.is_critical &&
+          javascript_custom_assertion_code == o.javascript_custom_assertion_code &&
+          locate_element_duration == o.locate_element_duration &&
+          name == o.name &&
+          request == o.request &&
+          response == o.response &&
+          retries == o.retries &&
+          retry_count == o.retry_count &&
+          rum_context == o.rum_context &&
+          started_at == o.started_at &&
+          status == o.status &&
+          sub_step == o.sub_step &&
+          sub_test == o.sub_test &&
+          subtype == o.subtype &&
+          tabs == o.tabs &&
+          timings == o.timings &&
+          tunnel == o.tunnel &&
+          type == o.type &&
+          url == o.url &&
+          value == o.value &&
+          variables == o.variables &&
+          vitals_metrics == o.vitals_metrics &&
+          warnings == o.warnings &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [allow_failure, api_test, assertion_result, assertions, blocked_requests_urls, bounds, browser_errors, bucket_keys, cdn_resources, click_type, compressed_json_descriptor, config, description, duration, element_description, element_updates, extracted_value, failure, http_results, id, is_critical, javascript_custom_assertion_code, locate_element_duration, name, request, response, retries, retry_count, rum_context, started_at, status, sub_step, sub_test, subtype, tabs, timings, tunnel, type, url, value, variables, vitals_metrics, warnings, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/synthetics_test_result_step_assertion_result.rb

@@ -0,0 +1,135 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Assertion result for a browser or mobile step.
+  class SyntheticsTestResultStepAssertionResult
+    include BaseGenericModel
+
+    # Actual value observed during the step assertion. Its type depends on the check type.
+    attr_accessor :actual
+
+    # Type of the step assertion check.
+    attr_accessor :check_type
+
+    # Expected value for the step assertion. Its type depends on the check type.
+    attr_accessor :expected
+
+    # Whether the assertion involves secure variables.
+    attr_accessor :has_secure_variables
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'actual' => :'actual',
+        :'check_type' => :'check_type',
+        :'expected' => :'expected',
+        :'has_secure_variables' => :'has_secure_variables'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'actual' => :'Object',
+        :'check_type' => :'String',
+        :'expected' => :'Object',
+        :'has_secure_variables' => :'Boolean'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::SyntheticsTestResultStepAssertionResult` initialize method"
+      end
+
+      self.additional_properties = {}
+      # 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))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'actual')
+        self.actual = attributes[:'actual']
+      end
+
+      if attributes.key?(:'check_type')
+        self.check_type = attributes[:'check_type']
+      end
+
+      if attributes.key?(:'expected')
+        self.expected = attributes[:'expected']
+      end
+
+      if attributes.key?(:'has_secure_variables')
+        self.has_secure_variables = attributes[:'has_secure_variables']
+      end
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    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
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          actual == o.actual &&
+          check_type == o.check_type &&
+          expected == o.expected &&
+          has_secure_variables == o.has_secure_variables &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [actual, check_type, expected, has_secure_variables, additional_properties].hash
+    end
+  end
+end