datadog_api_client 2.18.0 → 2.19.0

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

@@ -0,0 +1,114 @@
+=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
+  # Options on third party rules.
+  class SecurityMonitoringRuleThirdPartyOptions
+    include BaseGenericModel
+
+    # Notification targets for the logs that do not correspond to any of the cases.
+    attr_accessor :default_notifications
+
+    # Severity of the Security Signal.
+    attr_accessor :default_status
+
+    # Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.
+    attr_accessor :root_queries
+
+    # A template for the signal title; if omitted, the title is generated based on the case name.
+    attr_accessor :signal_title_template
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'default_notifications' => :'defaultNotifications',
+        :'default_status' => :'defaultStatus',
+        :'root_queries' => :'rootQueries',
+        :'signal_title_template' => :'signalTitleTemplate'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'default_notifications' => :'Array<String>',
+        :'default_status' => :'SecurityMonitoringRuleSeverity',
+        :'root_queries' => :'Array<SecurityMonitoringThirdPartyRootQuery>',
+        :'signal_title_template' => :'String'
+      }
+    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::SecurityMonitoringRuleThirdPartyOptions` 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::V2::SecurityMonitoringRuleThirdPartyOptions`. 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?(:'default_notifications')
+        if (value = attributes[:'default_notifications']).is_a?(Array)
+          self.default_notifications = value
+        end
+      end
+
+      if attributes.key?(:'default_status')
+        self.default_status = attributes[:'default_status']
+      end
+
+      if attributes.key?(:'root_queries')
+        if (value = attributes[:'root_queries']).is_a?(Array)
+          self.root_queries = value
+        end
+      end
+
+      if attributes.key?(:'signal_title_template')
+        self.signal_title_template = attributes[:'signal_title_template']
+      end
+    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 &&
+          default_notifications == o.default_notifications &&
+          default_status == o.default_status &&
+          root_queries == o.root_queries &&
+          signal_title_template == o.signal_title_template
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [default_notifications, default_status, root_queries, signal_title_template].hash
+    end
+  end
+end

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

@@ -51,6 +51,9 @@ module DatadogAPIClient::V2
     # Tags for generated signals.
     attr_accessor :tags
 
+    # Cases for generating signals from third party rules. Only available for third party rules.
+    attr_accessor :third_party_cases
+
     # The version of the rule being updated.
     attr_reader :version
 
@@ -68,6 +71,7 @@ module DatadogAPIClient::V2
         :'options' => :'options',
         :'queries' => :'queries',
         :'tags' => :'tags',
+        :'third_party_cases' => :'thirdPartyCases',
         :'version' => :'version'
       }
     end
@@ -86,6 +90,7 @@ module DatadogAPIClient::V2
         :'options' => :'SecurityMonitoringRuleOptions',
         :'queries' => :'Array<SecurityMonitoringRuleQuery>',
         :'tags' => :'Array<String>',
+        :'third_party_cases' => :'Array<SecurityMonitoringThirdPartyRuleCase>',
         :'version' => :'Integer'
       }
     end
@@ -154,6 +159,12 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'third_party_cases')
+        if (value = attributes[:'third_party_cases']).is_a?(Array)
+          self.third_party_cases = value
+        end
+      end
+
       if attributes.key?(:'version')
         self.version = attributes[:'version']
       end
@@ -193,6 +204,7 @@ module DatadogAPIClient::V2
           options == o.options &&
           queries == o.queries &&
           tags == o.tags &&
+          third_party_cases == o.third_party_cases &&
           version == o.version
     end
 
@@ -200,7 +212,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cases, compliance_signal_options, filters, has_extended_title, is_enabled, message, name, options, queries, tags, version].hash
+      [cases, compliance_signal_options, filters, has_extended_title, is_enabled, message, name, options, queries, tags, third_party_cases, version].hash
     end
   end
 end

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

@@ -48,6 +48,9 @@ module DatadogAPIClient::V2
     # Tags for generated signals.
     attr_accessor :tags
 
+    # Cases for generating signals from third party rules. Only available for third party rules.
+    attr_accessor :third_party_cases
+
     # The rule type.
     attr_accessor :type
 
@@ -64,6 +67,7 @@ module DatadogAPIClient::V2
         :'options' => :'options',
         :'queries' => :'queries',
         :'tags' => :'tags',
+        :'third_party_cases' => :'thirdPartyCases',
         :'type' => :'type'
       }
     end
@@ -81,6 +85,7 @@ module DatadogAPIClient::V2
         :'options' => :'SecurityMonitoringRuleOptions',
         :'queries' => :'Array<SecurityMonitoringStandardRuleQuery>',
         :'tags' => :'Array<String>',
+        :'third_party_cases' => :'Array<SecurityMonitoringThirdPartyRuleCaseCreate>',
         :'type' => :'SecurityMonitoringRuleTypeCreate'
       }
     end
@@ -145,6 +150,12 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'third_party_cases')
+        if (value = attributes[:'third_party_cases']).is_a?(Array)
+          self.third_party_cases = value
+        end
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -238,6 +249,7 @@ module DatadogAPIClient::V2
           options == o.options &&
           queries == o.queries &&
           tags == o.tags &&
+          third_party_cases == o.third_party_cases &&
           type == o.type
     end
 
@@ -245,7 +257,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cases, filters, has_extended_title, is_enabled, message, name, options, queries, tags, type].hash
+      [cases, filters, has_extended_title, is_enabled, message, name, options, queries, tags, third_party_cases, type].hash
     end
   end
 end

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

@@ -69,6 +69,9 @@ module DatadogAPIClient::V2
     # Tags for generated signals.
     attr_accessor :tags
 
+    # Cases for generating signals from third party rules. Only available for third party rules.
+    attr_accessor :third_party_cases
+
     # The rule type.
     attr_accessor :type
 
@@ -98,6 +101,7 @@ module DatadogAPIClient::V2
         :'options' => :'options',
         :'queries' => :'queries',
         :'tags' => :'tags',
+        :'third_party_cases' => :'thirdPartyCases',
         :'type' => :'type',
         :'update_author_id' => :'updateAuthorId',
         :'version' => :'version'
@@ -124,6 +128,7 @@ module DatadogAPIClient::V2
         :'options' => :'SecurityMonitoringRuleOptions',
         :'queries' => :'Array<SecurityMonitoringStandardRuleQuery>',
         :'tags' => :'Array<String>',
+        :'third_party_cases' => :'Array<SecurityMonitoringThirdPartyRuleCase>',
         :'type' => :'SecurityMonitoringRuleTypeRead',
         :'update_author_id' => :'Integer',
         :'version' => :'Integer'
@@ -218,6 +223,12 @@ module DatadogAPIClient::V2
         end
       end
 
+      if attributes.key?(:'third_party_cases')
+        if (value = attributes[:'third_party_cases']).is_a?(Array)
+          self.third_party_cases = value
+        end
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -253,6 +264,7 @@ module DatadogAPIClient::V2
           options == o.options &&
           queries == o.queries &&
           tags == o.tags &&
+          third_party_cases == o.third_party_cases &&
           type == o.type &&
           update_author_id == o.update_author_id &&
           version == o.version
@@ -262,7 +274,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cases, compliance_signal_options, created_at, creation_author_id, deprecation_date, filters, has_extended_title, id, is_default, is_deleted, is_enabled, message, name, options, queries, tags, type, update_author_id, version].hash
+      [cases, compliance_signal_options, created_at, creation_author_id, deprecation_date, filters, has_extended_title, id, is_default, is_deleted, is_enabled, message, name, options, queries, tags, third_party_cases, type, update_author_id, version].hash
     end
   end
 end

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

@@ -0,0 +1,92 @@
+=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 query to be combined with the third party case query.
+  class SecurityMonitoringThirdPartyRootQuery
+    include BaseGenericModel
+
+    # Fields to group by.
+    attr_accessor :group_by_fields
+
+    # Query to run on logs.
+    attr_accessor :query
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'group_by_fields' => :'groupByFields',
+        :'query' => :'query'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'group_by_fields' => :'Array<String>',
+        :'query' => :'String'
+      }
+    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::SecurityMonitoringThirdPartyRootQuery` 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::V2::SecurityMonitoringThirdPartyRootQuery`. 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?(:'group_by_fields')
+        if (value = attributes[:'group_by_fields']).is_a?(Array)
+          self.group_by_fields = value
+        end
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+    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 &&
+          group_by_fields == o.group_by_fields &&
+          query == o.query
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [group_by_fields, query].hash
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+=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
+  # Case when signal is generated by a third party rule.
+  class SecurityMonitoringThirdPartyRuleCase
+    include BaseGenericModel
+
+    # Name of the case.
+    attr_accessor :name
+
+    # Notification targets for each rule case.
+    attr_accessor :notifications
+
+    # A query to map a third party event to this case.
+    attr_accessor :query
+
+    # Severity of the Security Signal.
+    attr_accessor :status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'notifications' => :'notifications',
+        :'query' => :'query',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'notifications' => :'Array<String>',
+        :'query' => :'String',
+        :'status' => :'SecurityMonitoringRuleSeverity'
+      }
+    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::SecurityMonitoringThirdPartyRuleCase` 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::V2::SecurityMonitoringThirdPartyRuleCase`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'notifications')
+        if (value = attributes[:'notifications']).is_a?(Array)
+          self.notifications = value
+        end
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+    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 &&
+          name == o.name &&
+          notifications == o.notifications &&
+          query == o.query &&
+          status == o.status
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [name, notifications, query, status].hash
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+=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
+  # Case when a signal is generated by a third party rule.
+  class SecurityMonitoringThirdPartyRuleCaseCreate
+    include BaseGenericModel
+
+    # Name of the case.
+    attr_accessor :name
+
+    # Notification targets for each rule case.
+    attr_accessor :notifications
+
+    # A query to map a third party event to this case.
+    attr_accessor :query
+
+    # Severity of the Security Signal.
+    attr_reader :status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'notifications' => :'notifications',
+        :'query' => :'query',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'notifications' => :'Array<String>',
+        :'query' => :'String',
+        :'status' => :'SecurityMonitoringRuleSeverity'
+      }
+    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::SecurityMonitoringThirdPartyRuleCaseCreate` 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::V2::SecurityMonitoringThirdPartyRuleCaseCreate`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'notifications')
+        if (value = attributes[:'notifications']).is_a?(Array)
+          self.notifications = value
+        end
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      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 @status.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param status [Object] Object to be assigned
+    # @!visibility private
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'invalid value for "status", status cannot be nil.'
+      end
+      @status = status
+    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 &&
+          name == o.name &&
+          notifications == o.notifications &&
+          query == o.query &&
+          status == o.status
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [name, notifications, query, status].hash
+    end
+  end
+end