datadog_api_client 2.23.0 → 2.24.0

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

@@ -0,0 +1,118 @@
+=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
+  # Payload to test a rule query with the expected result.
+  class SecurityMonitoringRuleQueryPayload
+    include BaseGenericModel
+
+    # Expected result of the test.
+    attr_accessor :expected_result
+
+    # Index of the query under test.
+    attr_reader :index
+
+    # Payload used to test the rule query.
+    attr_accessor :payload
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'expected_result' => :'expectedResult',
+        :'index' => :'index',
+        :'payload' => :'payload'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'expected_result' => :'Boolean',
+        :'index' => :'Integer',
+        :'payload' => :'SecurityMonitoringRuleQueryPayloadData'
+      }
+    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::SecurityMonitoringRuleQueryPayload` 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::SecurityMonitoringRuleQueryPayload`. 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?(:'expected_result')
+        self.expected_result = attributes[:'expected_result']
+      end
+
+      if attributes.key?(:'index')
+        self.index = attributes[:'index']
+      end
+
+      if attributes.key?(:'payload')
+        self.payload = attributes[:'payload']
+      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 !@index.nil? && @index < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param index [Object] Object to be assigned
+    # @!visibility private
+    def index=(index)
+      if !index.nil? && index < 0
+        fail ArgumentError, 'invalid value for "index", must be greater than or equal to 0.'
+      end
+      @index = index
+    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 &&
+          expected_result == o.expected_result &&
+          index == o.index &&
+          payload == o.payload
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [expected_result, index, payload].hash
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+=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
+  # Payload used to test the rule query.
+  class SecurityMonitoringRuleQueryPayloadData
+    include BaseGenericModel
+
+    # Source of the payload.
+    attr_accessor :ddsource
+
+    # Tags associated with your data.
+    attr_accessor :ddtags
+
+    # The name of the originating host of the log.
+    attr_accessor :hostname
+
+    # The message of the payload.
+    attr_accessor :message
+
+    # The name of the application or service generating the data.
+    attr_accessor :service
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'ddsource' => :'ddsource',
+        :'ddtags' => :'ddtags',
+        :'hostname' => :'hostname',
+        :'message' => :'message',
+        :'service' => :'service'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'ddsource' => :'String',
+        :'ddtags' => :'String',
+        :'hostname' => :'String',
+        :'message' => :'String',
+        :'service' => :'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::SecurityMonitoringRuleQueryPayloadData` 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::SecurityMonitoringRuleQueryPayloadData`. 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?(:'ddsource')
+        self.ddsource = attributes[:'ddsource']
+      end
+
+      if attributes.key?(:'ddtags')
+        self.ddtags = attributes[:'ddtags']
+      end
+
+      if attributes.key?(:'hostname')
+        self.hostname = attributes[:'hostname']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'service')
+        self.service = attributes[:'service']
+      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 &&
+          ddsource == o.ddsource &&
+          ddtags == o.ddtags &&
+          hostname == o.hostname &&
+          message == o.message &&
+          service == o.service
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [ddsource, ddtags, hostname, message, service].hash
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+=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
+  # Test a rule.
+  module SecurityMonitoringRuleTestPayload
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'SecurityMonitoringStandardRuleTestPayload'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/security_monitoring_rule_test_request.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
+  # Test the rule queries of a rule (rule property is ignored when applied to an existing rule)
+  class SecurityMonitoringRuleTestRequest
+    include BaseGenericModel
+
+    # Test a rule.
+    attr_accessor :rule
+
+    # Data payloads used to test rules query with the expected result.
+    attr_accessor :rule_query_payloads
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'rule' => :'rule',
+        :'rule_query_payloads' => :'ruleQueryPayloads'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'rule' => :'SecurityMonitoringRuleTestPayload',
+        :'rule_query_payloads' => :'Array<SecurityMonitoringRuleQueryPayload>'
+      }
+    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::SecurityMonitoringRuleTestRequest` 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::SecurityMonitoringRuleTestRequest`. 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?(:'rule')
+        self.rule = attributes[:'rule']
+      end
+
+      if attributes.key?(:'rule_query_payloads')
+        if (value = attributes[:'rule_query_payloads']).is_a?(Array)
+          self.rule_query_payloads = value
+        end
+      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 &&
+          rule == o.rule &&
+          rule_query_payloads == o.rule_query_payloads
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [rule, rule_query_payloads].hash
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+=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
+  # Result of the test of the rule queries.
+  class SecurityMonitoringRuleTestResponse
+    include BaseGenericModel
+
+    # Assert results are returned in the same order as the rule query payloads.
+    # For each payload, it returns True if the result matched the expected result,
+    # False otherwise.
+    attr_accessor :results
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'results' => :'results'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'results' => :'Array<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::SecurityMonitoringRuleTestResponse` 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::SecurityMonitoringRuleTestResponse`. 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?(:'results')
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
+        end
+      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 &&
+          results == o.results
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [results].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/security_monitoring_rule_type_test.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 rule type.
+  class SecurityMonitoringRuleTypeTest
+    include BaseEnumModel
+
+    LOG_DETECTION = "log_detection".freeze
+  end
+end

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

@@ -51,7 +51,7 @@ module DatadogAPIClient::V2
     # Tags for generated signals.
     attr_accessor :tags
 
-    # Cases for generating signals from third party rules. Only available for third party rules.
+    # 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.

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

@@ -0,0 +1,64 @@
+=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
+  # Validate a rule.
+  module SecurityMonitoringRuleValidatePayload
+    class << self
+      include BaseOneOfModel
+      include BaseOneOfModelNoDiscriminator
+
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'SecurityMonitoringStandardRulePayload',
+          :'SecurityMonitoringSignalRulePayload',
+          :'CloudConfigurationRulePayload'
+        ]
+      end
+      # Builds the object
+      # @param data [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            next if typed_data.respond_to?(:_unparsed) && typed_data._unparsed
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        if openapi_one_of.include?(:AnyType)
+          data
+        else
+          self._unparsed = true
+          DatadogAPIClient::UnparsedObject.new(data)
+        end
+      end
+    end
+  end
+end