datadog_api_client 2.27.1 → 2.28.1

data/lib/datadog_api_client/v1/models/synthetics_mobile_test_options.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V1
   class SyntheticsMobileTestOptions
     include BaseGenericModel
 
-    # The `SyntheticsMobileTestOptions` `allowApplicationCrash`.
+    # A boolean to set if an application crash would mark the test as failed.
     attr_accessor :allow_application_crash
 
     # Array of bindings used for the mobile test.
@@ -30,32 +30,32 @@ module DatadogAPIClient::V1
     # CI/CD options for a Synthetic test.
     attr_accessor :ci
 
-    # The `SyntheticsMobileTestOptions` `defaultStepTimeout`.
+    # The default timeout for steps in the test (in seconds).
     attr_reader :default_step_timeout
 
     # For mobile test, array with the different device IDs used to run the test.
-    attr_accessor :device_ids
+    attr_reader :device_ids
 
-    # The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.
+    # A boolean to disable auto accepting alerts.
     attr_accessor :disable_auto_accept_alert
 
     # Minimum amount of time in failure required to trigger an alert.
     attr_reader :min_failure_duration
 
     # Mobile application for mobile synthetics test.
-    attr_accessor :mobile_application
+    attr_reader :mobile_application
 
     # The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
     attr_accessor :monitor_name
 
-    # Object containing the options for a mobile Synthetic test as a monitor
+    # Object containing the options for a Synthetic test as a monitor
     # (for example, renotification).
     attr_accessor :monitor_options
 
     # Integer from 1 (high) to 5 (low) indicating alert severity.
     attr_reader :monitor_priority
 
-    # The `SyntheticsMobileTestOptions` `noScreenshot`.
+    # A boolean set to not take a screenshot for the step.
     attr_accessor :no_screenshot
 
     # A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
@@ -70,7 +70,7 @@ module DatadogAPIClient::V1
     # The frequency at which to run the Synthetic test (in seconds).
     attr_reader :tick_every
 
-    # The `SyntheticsMobileTestOptions` `verbosity`.
+    # The level of verbosity for the mobile test.
     attr_reader :verbosity
 
     attr_accessor :additional_properties
@@ -104,15 +104,15 @@ module DatadogAPIClient::V1
     def self.openapi_types
       {
         :'allow_application_crash' => :'Boolean',
-        :'bindings' => :'Array<SyntheticsMobileTestBinding>',
-        :'ci' => :'SyntheticsMobileTestCiOptions',
+        :'bindings' => :'Array<SyntheticsTestRestrictionPolicyBinding>',
+        :'ci' => :'SyntheticsTestCiOptions',
         :'default_step_timeout' => :'Integer',
-        :'device_ids' => :'Array<SyntheticsMobileDeviceID>',
+        :'device_ids' => :'Array<String>',
         :'disable_auto_accept_alert' => :'Boolean',
         :'min_failure_duration' => :'Integer',
         :'mobile_application' => :'SyntheticsMobileTestsMobileApplication',
         :'monitor_name' => :'String',
-        :'monitor_options' => :'SyntheticsMobileTestOptionsMonitorOptions',
+        :'monitor_options' => :'SyntheticsTestOptionsMonitorOptions',
         :'monitor_priority' => :'Integer',
         :'no_screenshot' => :'Boolean',
         :'restricted_roles' => :'Array<String>',
@@ -222,12 +222,15 @@ module DatadogAPIClient::V1
     def valid?
       return false if !@default_step_timeout.nil? && @default_step_timeout > 300
       return false if !@default_step_timeout.nil? && @default_step_timeout < 1
+      return false if @device_ids.nil?
       return false if !@min_failure_duration.nil? && @min_failure_duration > 7200
       return false if !@min_failure_duration.nil? && @min_failure_duration < 0
+      return false if @mobile_application.nil?
       return false if !@monitor_priority.nil? && @monitor_priority > 5
       return false if !@monitor_priority.nil? && @monitor_priority < 1
-      return false if !@tick_every.nil? && @tick_every > 604800
-      return false if !@tick_every.nil? && @tick_every < 300
+      return false if @tick_every.nil?
+      return false if @tick_every > 604800
+      return false if @tick_every < 300
       return false if !@verbosity.nil? && @verbosity > 5
       return false if !@verbosity.nil? && @verbosity < 0
       true
@@ -246,6 +249,16 @@ module DatadogAPIClient::V1
       @default_step_timeout = default_step_timeout
     end
 
+    # Custom attribute writer method with validation
+    # @param device_ids [Object] Object to be assigned
+    # @!visibility private
+    def device_ids=(device_ids)
+      if device_ids.nil?
+        fail ArgumentError, 'invalid value for "device_ids", device_ids cannot be nil.'
+      end
+      @device_ids = device_ids
+    end
+
     # Custom attribute writer method with validation
     # @param min_failure_duration [Object] Object to be assigned
     # @!visibility private
@@ -259,6 +272,16 @@ module DatadogAPIClient::V1
       @min_failure_duration = min_failure_duration
     end
 
+    # Custom attribute writer method with validation
+    # @param mobile_application [Object] Object to be assigned
+    # @!visibility private
+    def mobile_application=(mobile_application)
+      if mobile_application.nil?
+        fail ArgumentError, 'invalid value for "mobile_application", mobile_application cannot be nil.'
+      end
+      @mobile_application = mobile_application
+    end
+
     # Custom attribute writer method with validation
     # @param monitor_priority [Object] Object to be assigned
     # @!visibility private
@@ -276,10 +299,13 @@ module DatadogAPIClient::V1
     # @param tick_every [Object] Object to be assigned
     # @!visibility private
     def tick_every=(tick_every)
-      if !tick_every.nil? && tick_every > 604800
+      if tick_every.nil?
+        fail ArgumentError, 'invalid value for "tick_every", tick_every cannot be nil.'
+      end
+      if tick_every > 604800
         fail ArgumentError, 'invalid value for "tick_every", must be smaller than or equal to 604800.'
       end
-      if !tick_every.nil? && tick_every < 300
+      if tick_every < 300
         fail ArgumentError, 'invalid value for "tick_every", must be greater than or equal to 300.'
       end
       @tick_every = tick_every

data/lib/datadog_api_client/v1/models/synthetics_mobile_tests_mobile_application.rb

@@ -28,7 +28,7 @@ module DatadogAPIClient::V1
     attr_reader :reference_id
 
     # Reference type for the mobile application for a mobile synthetics test.
-    attr_accessor :reference_type
+    attr_reader :reference_type
 
     attr_accessor :additional_properties
 
@@ -87,8 +87,11 @@ module DatadogAPIClient::V1
     # @return true if the model is valid
     # @!visibility private
     def valid?
-      return false if !@application_id.nil? && @application_id.to_s.length > 1500
-      return false if !@reference_id.nil? && @reference_id.to_s.length > 1500
+      return false if @application_id.nil?
+      return false if @application_id.to_s.length > 1500
+      return false if @reference_id.nil?
+      return false if @reference_id.to_s.length > 1500
+      return false if @reference_type.nil?
       true
     end
 
@@ -96,7 +99,10 @@ module DatadogAPIClient::V1
     # @param application_id [Object] Object to be assigned
     # @!visibility private
     def application_id=(application_id)
-      if !application_id.nil? && application_id.to_s.length > 1500
+      if application_id.nil?
+        fail ArgumentError, 'invalid value for "application_id", application_id cannot be nil.'
+      end
+      if application_id.to_s.length > 1500
         fail ArgumentError, 'invalid value for "application_id", the character length must be smaller than or equal to 1500.'
       end
       @application_id = application_id
@@ -106,12 +112,25 @@ module DatadogAPIClient::V1
     # @param reference_id [Object] Object to be assigned
     # @!visibility private
     def reference_id=(reference_id)
-      if !reference_id.nil? && reference_id.to_s.length > 1500
+      if reference_id.nil?
+        fail ArgumentError, 'invalid value for "reference_id", reference_id cannot be nil.'
+      end
+      if reference_id.to_s.length > 1500
         fail ArgumentError, 'invalid value for "reference_id", the character length must be smaller than or equal to 1500.'
       end
       @reference_id = reference_id
     end
 
+    # Custom attribute writer method with validation
+    # @param reference_type [Object] Object to be assigned
+    # @!visibility private
+    def reference_type=(reference_type)
+      if reference_type.nil?
+        fail ArgumentError, 'invalid value for "reference_type", reference_type cannot be nil.'
+      end
+      @reference_type = reference_type
+    end
+
     # Returns the object in the form of hash, with additionalProperties support.
     # @return [Hash] Returns the object in the form of hash
     # @!visibility private

data/lib/datadog_api_client/v1/models/synthetics_step.rb

@@ -24,13 +24,19 @@ module DatadogAPIClient::V1
     # A boolean set to allow this step to fail.
     attr_accessor :allow_failure
 
+    # A boolean set to always execute this step even if the previous step failed or was skipped.
+    attr_accessor :always_execute
+
+    # A boolean set to exit the test if the step succeeds.
+    attr_accessor :exit_if_succeed
+
     # A boolean to use in addition to `allowFailure` to determine if the test should be marked as failed when the step fails.
     attr_accessor :is_critical
 
     # The name of the step.
     attr_accessor :name
 
-    # A boolean set to not take a screenshot for the step.
+    # A boolean set to skip taking a screenshot for the step.
     attr_accessor :no_screenshot
 
     # The parameters of the step.
@@ -49,6 +55,8 @@ module DatadogAPIClient::V1
     def self.attribute_map
       {
         :'allow_failure' => :'allowFailure',
+        :'always_execute' => :'alwaysExecute',
+        :'exit_if_succeed' => :'exitIfSucceed',
         :'is_critical' => :'isCritical',
         :'name' => :'name',
         :'no_screenshot' => :'noScreenshot',
@@ -63,6 +71,8 @@ module DatadogAPIClient::V1
     def self.openapi_types
       {
         :'allow_failure' => :'Boolean',
+        :'always_execute' => :'Boolean',
+        :'exit_if_succeed' => :'Boolean',
         :'is_critical' => :'Boolean',
         :'name' => :'String',
         :'no_screenshot' => :'Boolean',
@@ -94,6 +104,14 @@ module DatadogAPIClient::V1
         self.allow_failure = attributes[:'allow_failure']
       end
 
+      if attributes.key?(:'always_execute')
+        self.always_execute = attributes[:'always_execute']
+      end
+
+      if attributes.key?(:'exit_if_succeed')
+        self.exit_if_succeed = attributes[:'exit_if_succeed']
+      end
+
       if attributes.key?(:'is_critical')
         self.is_critical = attributes[:'is_critical']
       end
@@ -146,6 +164,8 @@ module DatadogAPIClient::V1
       return true if self.equal?(o)
       self.class == o.class &&
           allow_failure == o.allow_failure &&
+          always_execute == o.always_execute &&
+          exit_if_succeed == o.exit_if_succeed &&
           is_critical == o.is_critical &&
           name == o.name &&
           no_screenshot == o.no_screenshot &&
@@ -159,7 +179,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [allow_failure, is_critical, name, no_screenshot, params, timeout, type].hash
+      [allow_failure, always_execute, exit_if_succeed, is_critical, name, no_screenshot, params, timeout, type].hash
     end
   end
 end

data/lib/datadog_api_client/v1/models/synthetics_step_detail.rb

@@ -21,6 +21,9 @@ module DatadogAPIClient::V1
   class SyntheticsStepDetail
     include BaseGenericModel
 
+    # Whether or not the step was allowed to fail.
+    attr_accessor :allow_failure
+
     # Array of errors collected for a browser test.
     attr_accessor :browser_errors
 
@@ -36,6 +39,9 @@ module DatadogAPIClient::V1
     # Error returned by the test.
     attr_accessor :error
 
+    # The browser test failure details.
+    attr_accessor :failure
+
     # Navigate between different tabs for your browser test.
     attr_accessor :playing_tab
 
@@ -79,11 +85,13 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.attribute_map
       {
+        :'allow_failure' => :'allowFailure',
         :'browser_errors' => :'browserErrors',
         :'check_type' => :'checkType',
         :'description' => :'description',
         :'duration' => :'duration',
         :'error' => :'error',
+        :'failure' => :'failure',
         :'playing_tab' => :'playingTab',
         :'screenshot_bucket_key' => :'screenshotBucketKey',
         :'skipped' => :'skipped',
@@ -103,11 +111,13 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.openapi_types
       {
+        :'allow_failure' => :'Boolean',
         :'browser_errors' => :'Array<SyntheticsBrowserError>',
         :'check_type' => :'SyntheticsCheckType',
         :'description' => :'String',
         :'duration' => :'Float',
         :'error' => :'String',
+        :'failure' => :'SyntheticsBrowserTestResultFailure',
         :'playing_tab' => :'SyntheticsPlayingTab',
         :'screenshot_bucket_key' => :'Boolean',
         :'skipped' => :'Boolean',
@@ -141,6 +151,10 @@ module DatadogAPIClient::V1
         end
       }
 
+      if attributes.key?(:'allow_failure')
+        self.allow_failure = attributes[:'allow_failure']
+      end
+
       if attributes.key?(:'browser_errors')
         if (value = attributes[:'browser_errors']).is_a?(Array)
           self.browser_errors = value
@@ -163,6 +177,10 @@ module DatadogAPIClient::V1
         self.error = attributes[:'error']
       end
 
+      if attributes.key?(:'failure')
+        self.failure = attributes[:'failure']
+      end
+
       if attributes.key?(:'playing_tab')
         self.playing_tab = attributes[:'playing_tab']
       end
@@ -244,11 +262,13 @@ module DatadogAPIClient::V1
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          allow_failure == o.allow_failure &&
           browser_errors == o.browser_errors &&
           check_type == o.check_type &&
           description == o.description &&
           duration == o.duration &&
           error == o.error &&
+          failure == o.failure &&
           playing_tab == o.playing_tab &&
           screenshot_bucket_key == o.screenshot_bucket_key &&
           skipped == o.skipped &&
@@ -268,7 +288,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     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
+      [allow_failure, browser_errors, check_type, description, duration, error, failure, 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
   end
 end

data/lib/datadog_api_client/v1/models/synthetics_test_ci_options.rb

@@ -22,7 +22,7 @@ module DatadogAPIClient::V1
     include BaseGenericModel
 
     # Execution rule for a Synthetic test.
-    attr_accessor :execution_rule
+    attr_reader :execution_rule
 
     attr_accessor :additional_properties
 
@@ -65,6 +65,24 @@ module DatadogAPIClient::V1
       end
     end
 
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @execution_rule.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param execution_rule [Object] Object to be assigned
+    # @!visibility private
+    def execution_rule=(execution_rule)
+      if execution_rule.nil?
+        fail ArgumentError, 'invalid value for "execution_rule", execution_rule cannot be nil.'
+      end
+      @execution_rule = execution_rule
+    end
+
     # Returns the object in the form of hash, with additionalProperties support.
     # @return [Hash] Returns the object in the form of hash
     # @!visibility private

data/lib/datadog_api_client/v1/models/synthetics_test_details_type.rb

@@ -23,5 +23,6 @@ module DatadogAPIClient::V1
 
     API = "api".freeze
     BROWSER = "browser".freeze
+    MOBILE = "mobile".freeze
   end
 end

data/lib/datadog_api_client/v1/models/synthetics_test_options_monitor_options.rb

@@ -22,17 +22,29 @@ module DatadogAPIClient::V1
   class SyntheticsTestOptionsMonitorOptions
     include BaseGenericModel
 
+    # Message to include in the escalation notification.
+    attr_accessor :escalation_message
+
+    # The name of the preset for the notification for the monitor.
+    attr_accessor :notification_preset_name
+
     # Time interval before renotifying if the test is still failing
     # (in minutes).
     attr_reader :renotify_interval
 
+    # The number of times to renotify if the test is still failing.
+    attr_accessor :renotify_occurrences
+
     attr_accessor :additional_properties
 
     # Attribute mapping from ruby-style variable name to JSON key.
     # @!visibility private
     def self.attribute_map
       {
-        :'renotify_interval' => :'renotify_interval'
+        :'escalation_message' => :'escalation_message',
+        :'notification_preset_name' => :'notification_preset_name',
+        :'renotify_interval' => :'renotify_interval',
+        :'renotify_occurrences' => :'renotify_occurrences'
       }
     end
 
@@ -40,7 +52,10 @@ module DatadogAPIClient::V1
     # @!visibility private
     def self.openapi_types
       {
-        :'renotify_interval' => :'Integer'
+        :'escalation_message' => :'String',
+        :'notification_preset_name' => :'SyntheticsTestOptionsMonitorOptionsNotificationPresetName',
+        :'renotify_interval' => :'Integer',
+        :'renotify_occurrences' => :'Integer'
       }
     end
 
@@ -62,9 +77,21 @@ module DatadogAPIClient::V1
         end
       }
 
+      if attributes.key?(:'escalation_message')
+        self.escalation_message = attributes[:'escalation_message']
+      end
+
+      if attributes.key?(:'notification_preset_name')
+        self.notification_preset_name = attributes[:'notification_preset_name']
+      end
+
       if attributes.key?(:'renotify_interval')
         self.renotify_interval = attributes[:'renotify_interval']
       end
+
+      if attributes.key?(:'renotify_occurrences')
+        self.renotify_occurrences = attributes[:'renotify_occurrences']
+      end
     end
 
     # Check to see if the all the properties in the model are valid
@@ -111,7 +138,10 @@ module DatadogAPIClient::V1
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          renotify_interval == o.renotify_interval
+          escalation_message == o.escalation_message &&
+          notification_preset_name == o.notification_preset_name &&
+          renotify_interval == o.renotify_interval &&
+          renotify_occurrences == o.renotify_occurrences
           additional_properties == o.additional_properties
     end
 
@@ -119,7 +149,7 @@ module DatadogAPIClient::V1
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [renotify_interval].hash
+      [escalation_message, notification_preset_name, renotify_interval, renotify_occurrences].hash
     end
   end
 end

data/lib/datadog_api_client/v1/models/{synthetics_mobile_test_options_monitor_options_notification_preset_name.rb → synthetics_test_options_monitor_options_notification_preset_name.rb}

@@ -17,8 +17,8 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V1
-  # The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.
-  class SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName
+  # The name of the preset for the notification for the monitor.
+  class SyntheticsTestOptionsMonitorOptionsNotificationPresetName
     include BaseEnumModel
 
     SHOW_ALL = "show_all".freeze

data/lib/datadog_api_client/v1/models/synthetics_test_options_scheduling.rb

@@ -22,10 +22,10 @@ module DatadogAPIClient::V1
     include BaseGenericModel
 
     # Array containing objects describing the scheduling pattern to apply to each day.
-    attr_accessor :timeframes
+    attr_reader :timeframes
 
     # Timezone in which the timeframe is based.
-    attr_accessor :timezone
+    attr_reader :timezone
 
     attr_accessor :additional_properties
 
@@ -76,6 +76,35 @@ module DatadogAPIClient::V1
       end
     end
 
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @timeframes.nil?
+      return false if @timezone.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param timeframes [Object] Object to be assigned
+    # @!visibility private
+    def timeframes=(timeframes)
+      if timeframes.nil?
+        fail ArgumentError, 'invalid value for "timeframes", timeframes cannot be nil.'
+      end
+      @timeframes = timeframes
+    end
+
+    # Custom attribute writer method with validation
+    # @param timezone [Object] Object to be assigned
+    # @!visibility private
+    def timezone=(timezone)
+      if timezone.nil?
+        fail ArgumentError, 'invalid value for "timezone", timezone cannot be nil.'
+      end
+      @timezone = timezone
+    end
+
     # Returns the object in the form of hash, with additionalProperties support.
     # @return [Hash] Returns the object in the form of hash
     # @!visibility private

data/lib/datadog_api_client/v1/models/synthetics_test_options_scheduling_timeframe.rb

@@ -25,10 +25,10 @@ module DatadogAPIClient::V1
     attr_reader :day
 
     # The hour of the day on which scheduling starts.
-    attr_accessor :from
+    attr_reader :from
 
     # The hour of the day on which scheduling ends.
-    attr_accessor :to
+    attr_reader :to
 
     attr_accessor :additional_properties
 
@@ -87,8 +87,11 @@ module DatadogAPIClient::V1
     # @return true if the model is valid
     # @!visibility private
     def valid?
-      return false if !@day.nil? && @day > 7
-      return false if !@day.nil? && @day < 1
+      return false if @day.nil?
+      return false if @day > 7
+      return false if @day < 1
+      return false if @from.nil?
+      return false if @to.nil?
       true
     end
 
@@ -96,15 +99,38 @@ module DatadogAPIClient::V1
     # @param day [Object] Object to be assigned
     # @!visibility private
     def day=(day)
-      if !day.nil? && day > 7
+      if day.nil?
+        fail ArgumentError, 'invalid value for "day", day cannot be nil.'
+      end
+      if day > 7
         fail ArgumentError, 'invalid value for "day", must be smaller than or equal to 7.'
       end
-      if !day.nil? && day < 1
+      if day < 1
         fail ArgumentError, 'invalid value for "day", must be greater than or equal to 1.'
       end
       @day = day
     end
 
+    # Custom attribute writer method with validation
+    # @param from [Object] Object to be assigned
+    # @!visibility private
+    def from=(from)
+      if from.nil?
+        fail ArgumentError, 'invalid value for "from", from cannot be nil.'
+      end
+      @from = from
+    end
+
+    # Custom attribute writer method with validation
+    # @param to [Object] Object to be assigned
+    # @!visibility private
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'invalid value for "to", to cannot be nil.'
+      end
+      @to = to
+    end
+
     # Returns the object in the form of hash, with additionalProperties support.
     # @return [Hash] Returns the object in the form of hash
     # @!visibility private