datadog_api_client 2.29.1 → 2.30.0

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Reference table for the rule.
+  # Reference tables used in the queries.
   class SecurityMonitoringReferenceTable
     include BaseGenericModel
 
@@ -30,7 +30,7 @@ module DatadogAPIClient::V2
     # The field in the log to match against the reference table.
     attr_accessor :log_field_path
 
-    # The name of the rule query to apply the reference table to.
+    # The name of the query to apply the reference table to.
     attr_accessor :rule_query_name
 
     # The name of the reference table.

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

@@ -21,14 +21,14 @@ module DatadogAPIClient::V2
   class SecurityMonitoringRuleCaseCreate
     include BaseGenericModel
 
-    # A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated
+    # A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated
     # based on the event counts in the previously defined queries.
     attr_accessor :condition
 
     # Name of the case.
     attr_accessor :name
 
-    # Notification targets for each rule case.
+    # Notification targets.
     attr_accessor :notifications
 
     # Severity of the Security Signal.

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

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # A time window is specified to match when at least one of the cases matches true. This is a sliding window
-  # and evaluates in real time. For third party rules, this field is not used.
+  # and evaluates in real time. For third party detection method, this field is not used.
   class SecurityMonitoringRuleEvaluationWindow
     include BaseEnumModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Options on impossible travel rules.
+  # Options on impossible travel detection method.
   class SecurityMonitoringRuleImpossibleTravelOptions
     include BaseGenericModel
 

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

@@ -18,7 +18,7 @@ require 'time'
 
 module DatadogAPIClient::V2
   # Once a signal is generated, the signal will remain “open” if a case is matched at least once within
-  # this keep alive window. For third party rules, this field is not used.
+  # this keep alive window. For third party detection method, this field is not used.
   class SecurityMonitoringRuleKeepAlive
     include BaseEnumModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Options on new value rules.
+  # Options on new value detection method.
   class SecurityMonitoringRuleNewValueOptions
     include BaseGenericModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Options on rules.
+  # Options.
   class SecurityMonitoringRuleOptions
     include BaseGenericModel
 
@@ -35,27 +35,27 @@ module DatadogAPIClient::V2
     attr_accessor :detection_method
 
     # A time window is specified to match when at least one of the cases matches true. This is a sliding window
-    # and evaluates in real time. For third party rules, this field is not used.
+    # and evaluates in real time. For third party detection method, this field is not used.
     attr_accessor :evaluation_window
 
     # Hardcoded evaluator type.
     attr_accessor :hardcoded_evaluator_type
 
-    # Options on impossible travel rules.
+    # Options on impossible travel detection method.
     attr_accessor :impossible_travel_options
 
     # Once a signal is generated, the signal will remain “open” if a case is matched at least once within
-    # this keep alive window. For third party rules, this field is not used.
+    # this keep alive window. For third party detection method, this field is not used.
     attr_accessor :keep_alive
 
     # A signal will “close” regardless of the query being matched once the time exceeds the maximum duration.
     # This time is calculated from the first seen timestamp.
     attr_accessor :max_signal_duration
 
-    # Options on new value rules.
+    # Options on new value detection method.
     attr_accessor :new_value_options
 
-    # Options on third party rules.
+    # Options on third party detection method.
     attr_accessor :third_party_rule_options
 
     attr_accessor :additional_properties

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Options on third party rules.
+  # Options on third party detection method.
   class SecurityMonitoringRuleThirdPartyOptions
     include BaseGenericModel
 

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

@@ -42,7 +42,7 @@ module DatadogAPIClient::V2
     # Name of the rule.
     attr_accessor :name
 
-    # Options on rules.
+    # Options.
     attr_accessor :options
 
     # Queries for selecting logs which are part of the rule.

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

@@ -39,7 +39,7 @@ module DatadogAPIClient::V2
     # The name of the rule.
     attr_reader :name
 
-    # Options on rules.
+    # Options.
     attr_reader :options
 
     # Queries for selecting signals which are part of the rule.

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

@@ -39,7 +39,7 @@ module DatadogAPIClient::V2
     # The name of the rule.
     attr_reader :name
 
-    # Options on rules.
+    # Options.
     attr_reader :options
 
     # Queries for selecting signals which are part of the rule.

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

@@ -57,7 +57,7 @@ module DatadogAPIClient::V2
     # The name of the rule.
     attr_accessor :name
 
-    # Options on rules.
+    # Options.
     attr_accessor :options
 
     # Queries for selecting logs which are part of the rule.

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

@@ -39,7 +39,7 @@ module DatadogAPIClient::V2
     # The name of the rule.
     attr_reader :name
 
-    # Options on rules.
+    # Options.
     attr_reader :options
 
     # Queries for selecting logs which are part of the rule.

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

@@ -39,7 +39,7 @@ module DatadogAPIClient::V2
     # The name of the rule.
     attr_reader :name
 
-    # Options on rules.
+    # Options.
     attr_reader :options
 
     # Queries for selecting logs which are part of the rule.

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

@@ -63,7 +63,7 @@ module DatadogAPIClient::V2
     # The name of the rule.
     attr_accessor :name
 
-    # Options on rules.
+    # Options.
     attr_accessor :options
 
     # Queries for selecting logs which are part of the rule.

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

@@ -39,7 +39,7 @@ module DatadogAPIClient::V2
     # The name of the rule.
     attr_reader :name
 
-    # Options on rules.
+    # Options.
     attr_reader :options
 
     # Queries for selecting logs which are part of the rule.

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

@@ -48,6 +48,9 @@ module DatadogAPIClient::V2
     # The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
     attr_accessor :rule_query
 
+    # A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
+    attr_accessor :start_date
+
     # The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
     attr_accessor :suppression_query
 
@@ -75,6 +78,7 @@ module DatadogAPIClient::V2
         :'expiration_date' => :'expiration_date',
         :'name' => :'name',
         :'rule_query' => :'rule_query',
+        :'start_date' => :'start_date',
         :'suppression_query' => :'suppression_query',
         :'update_date' => :'update_date',
         :'updater' => :'updater',
@@ -95,6 +99,7 @@ module DatadogAPIClient::V2
         :'expiration_date' => :'Integer',
         :'name' => :'String',
         :'rule_query' => :'String',
+        :'start_date' => :'Integer',
         :'suppression_query' => :'String',
         :'update_date' => :'Integer',
         :'updater' => :'SecurityMonitoringUser',
@@ -156,6 +161,10 @@ module DatadogAPIClient::V2
         self.rule_query = attributes[:'rule_query']
       end
 
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
       if attributes.key?(:'suppression_query')
         self.suppression_query = attributes[:'suppression_query']
       end
@@ -226,6 +235,7 @@ module DatadogAPIClient::V2
           expiration_date == o.expiration_date &&
           name == o.name &&
           rule_query == o.rule_query &&
+          start_date == o.start_date &&
           suppression_query == o.suppression_query &&
           update_date == o.update_date &&
           updater == o.updater &&
@@ -237,7 +247,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [creation_date, creator, data_exclusion_query, description, editable, enabled, expiration_date, name, rule_query, suppression_query, update_date, updater, version, additional_properties].hash
+      [creation_date, creator, data_exclusion_query, description, editable, enabled, expiration_date, name, rule_query, start_date, suppression_query, update_date, updater, version, additional_properties].hash
     end
   end
 end

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

@@ -39,6 +39,9 @@ module DatadogAPIClient::V2
     # The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
     attr_reader :rule_query
 
+    # A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals.
+    attr_accessor :start_date
+
     # The suppression query of the suppression rule. If a signal matches this query, it is suppressed and is not triggered. It uses the same syntax as the queries to search signals in the Signals Explorer.
     attr_accessor :suppression_query
 
@@ -54,6 +57,7 @@ module DatadogAPIClient::V2
         :'expiration_date' => :'expiration_date',
         :'name' => :'name',
         :'rule_query' => :'rule_query',
+        :'start_date' => :'start_date',
         :'suppression_query' => :'suppression_query'
       }
     end
@@ -68,6 +72,7 @@ module DatadogAPIClient::V2
         :'expiration_date' => :'Integer',
         :'name' => :'String',
         :'rule_query' => :'String',
+        :'start_date' => :'Integer',
         :'suppression_query' => :'String'
       }
     end
@@ -114,6 +119,10 @@ module DatadogAPIClient::V2
         self.rule_query = attributes[:'rule_query']
       end
 
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
       if attributes.key?(:'suppression_query')
         self.suppression_query = attributes[:'suppression_query']
       end
@@ -191,6 +200,7 @@ module DatadogAPIClient::V2
           expiration_date == o.expiration_date &&
           name == o.name &&
           rule_query == o.rule_query &&
+          start_date == o.start_date &&
           suppression_query == o.suppression_query &&
           additional_properties == o.additional_properties
     end
@@ -199,7 +209,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [data_exclusion_query, description, enabled, expiration_date, name, rule_query, suppression_query, additional_properties].hash
+      [data_exclusion_query, description, enabled, expiration_date, name, rule_query, start_date, suppression_query, additional_properties].hash
     end
   end
 end

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

@@ -39,6 +39,9 @@ module DatadogAPIClient::V2
     # The rule query of the suppression rule, with the same syntax as the search bar for detection rules.
     attr_accessor :rule_query
 
+    # A Unix millisecond timestamp giving the start date for the suppression rule. After this date, it starts suppressing signals. If unset, the start date of the suppression rule is left untouched. If set to `null`, the start date is removed.
+    attr_accessor :start_date
+
     # The suppression query of the suppression rule. If a signal matches this query, it is suppressed and not triggered. Same syntax as the queries to search signals in the signal explorer.
     attr_accessor :suppression_query
 
@@ -57,6 +60,7 @@ module DatadogAPIClient::V2
         :'expiration_date' => :'expiration_date',
         :'name' => :'name',
         :'rule_query' => :'rule_query',
+        :'start_date' => :'start_date',
         :'suppression_query' => :'suppression_query',
         :'version' => :'version'
       }
@@ -72,6 +76,7 @@ module DatadogAPIClient::V2
         :'expiration_date' => :'Integer',
         :'name' => :'String',
         :'rule_query' => :'String',
+        :'start_date' => :'Integer',
         :'suppression_query' => :'String',
         :'version' => :'Integer'
       }
@@ -82,6 +87,7 @@ module DatadogAPIClient::V2
     def self.openapi_nullable
       Set.new([
         :'expiration_date',
+        :'start_date',
       ])
     end
 
@@ -127,6 +133,10 @@ module DatadogAPIClient::V2
         self.rule_query = attributes[:'rule_query']
       end
 
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
       if attributes.key?(:'suppression_query')
         self.suppression_query = attributes[:'suppression_query']
       end
@@ -186,6 +196,7 @@ module DatadogAPIClient::V2
           expiration_date == o.expiration_date &&
           name == o.name &&
           rule_query == o.rule_query &&
+          start_date == o.start_date &&
           suppression_query == o.suppression_query &&
           version == o.version &&
           additional_properties == o.additional_properties
@@ -195,7 +206,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [data_exclusion_query, description, enabled, expiration_date, name, rule_query, suppression_query, version, additional_properties].hash
+      [data_exclusion_query, description, enabled, expiration_date, name, rule_query, start_date, suppression_query, version, additional_properties].hash
     end
   end
 end

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

@@ -24,7 +24,7 @@ module DatadogAPIClient::V2
     # Name of the case.
     attr_accessor :name
 
-    # Notification targets for each rule case.
+    # Notification targets for each case.
     attr_accessor :notifications
 
     # A query to map a third party event to this case.

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

@@ -0,0 +1,160 @@
+=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
+  # Selectors are used to filter security issues for which notifications should be generated.
+  # Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source.
+  # Only the trigger_source field is required.
+  class Selectors
+    include BaseGenericModel
+
+    # The query is composed of one or several key:value pairs, which can be used to filter security issues on tags and attributes.
+    attr_accessor :query
+
+    # Security rule types used to filter signals and vulnerabilities generating notifications.
+    attr_accessor :rule_types
+
+    # The security rules severities to consider.
+    attr_accessor :severities
+
+    # The type of security issues on which the rule applies. Notification rules based on security signals need to use the trigger source "security_signals",
+    # while notification rules based on security vulnerabilities need to use the trigger source "security_findings".
+    attr_reader :trigger_source
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'query' => :'query',
+        :'rule_types' => :'rule_types',
+        :'severities' => :'severities',
+        :'trigger_source' => :'trigger_source'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'query' => :'String',
+        :'rule_types' => :'Array<RuleTypesItems>',
+        :'severities' => :'Array<RuleSeverity>',
+        :'trigger_source' => :'TriggerSource'
+      }
+    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::Selectors` 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?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'rule_types')
+        if (value = attributes[:'rule_types']).is_a?(Array)
+          self.rule_types = value
+        end
+      end
+
+      if attributes.key?(:'severities')
+        if (value = attributes[:'severities']).is_a?(Array)
+          self.severities = value
+        end
+      end
+
+      if attributes.key?(:'trigger_source')
+        self.trigger_source = attributes[:'trigger_source']
+      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 @trigger_source.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param trigger_source [Object] Object to be assigned
+    # @!visibility private
+    def trigger_source=(trigger_source)
+      if trigger_source.nil?
+        fail ArgumentError, 'invalid value for "trigger_source", trigger_source cannot be nil.'
+      end
+      @trigger_source = trigger_source
+    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 &&
+          query == o.query &&
+          rule_types == o.rule_types &&
+          severities == o.severities &&
+          trigger_source == o.trigger_source &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [query, rule_types, severities, trigger_source, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+=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
+  # The version of the CycloneDX specification a BOM conforms to.
+  class SpecVersion
+    include BaseEnumModel
+
+    ONE_ZERO = "1.0".freeze
+    ONE_ONE = "1.1".freeze
+    ONE_TWO = "1.2".freeze
+    ONE_THREE = "1.3".freeze
+    ONE_FOUR = "1.4".freeze
+    ONE_FIVE = "1.5".freeze
+  end
+end

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

@@ -0,0 +1,26 @@
+=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
+  # The definition of `TokenType` object.
+  class TokenType
+    include BaseEnumModel
+
+    SECRET = "SECRET".freeze
+  end
+end

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

@@ -0,0 +1,28 @@
+=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
+  # The type of security issues on which the rule applies. Notification rules based on security signals need to use the trigger source "security_signals",
+  # while notification rules based on security vulnerabilities need to use the trigger source "security_findings".
+  class TriggerSource
+    include BaseEnumModel
+
+    SECURITY_FINDINGS = "security_findings".freeze
+    SECURITY_SIGNALS = "security_signals".freeze
+  end
+end