datadog_api_client 2.56.0 → 2.57.0

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

@@ -0,0 +1,250 @@
+=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
+  # Details for a logs-based content pack.
+  class SecurityMonitoringContentPackLogsDetails
+    include BaseGenericModel
+
+    # The activation status of a content pack.
+    attr_reader :cp_activation
+
+    # Timestamp bucket indicating when logs were last collected.
+    attr_reader :data_last_seen
+
+    # Whether filters (Security Filters or Index Query depending on the pricing model) are
+    # present and correctly configured to route logs into Cloud SIEM.
+    attr_reader :filters_configured
+
+    # The installation status of the related integration.
+    attr_reader :integration_installed_status
+
+    # Whether logs for this content pack have been seen in any Datadog index in the last 72 hours.
+    attr_reader :logs_seen_from_any_index
+
+    # Whether the Cloud SIEM index configuration is incorrect (only applies to certain pricing models).
+    attr_reader :siem_index_incorrect
+
+    # The filtered data type.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'cp_activation' => :'cp_activation',
+        :'data_last_seen' => :'data_last_seen',
+        :'filters_configured' => :'filters_configured',
+        :'integration_installed_status' => :'integration_installed_status',
+        :'logs_seen_from_any_index' => :'logs_seen_from_any_index',
+        :'siem_index_incorrect' => :'siem_index_incorrect',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'cp_activation' => :'SecurityMonitoringContentPackActivation',
+        :'data_last_seen' => :'SecurityMonitoringContentPackTimestampBucket',
+        :'filters_configured' => :'Boolean',
+        :'integration_installed_status' => :'SecurityMonitoringContentPackIntegrationStatus',
+        :'logs_seen_from_any_index' => :'Boolean',
+        :'siem_index_incorrect' => :'Boolean',
+        :'type' => :'SecurityFilterFilteredDataType'
+      }
+    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::SecurityMonitoringContentPackLogsDetails` 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?(:'cp_activation')
+        self.cp_activation = attributes[:'cp_activation']
+      end
+
+      if attributes.key?(:'data_last_seen')
+        self.data_last_seen = attributes[:'data_last_seen']
+      end
+
+      if attributes.key?(:'filters_configured')
+        self.filters_configured = attributes[:'filters_configured']
+      end
+
+      if attributes.key?(:'integration_installed_status')
+        self.integration_installed_status = attributes[:'integration_installed_status']
+      end
+
+      if attributes.key?(:'logs_seen_from_any_index')
+        self.logs_seen_from_any_index = attributes[:'logs_seen_from_any_index']
+      end
+
+      if attributes.key?(:'siem_index_incorrect')
+        self.siem_index_incorrect = attributes[:'siem_index_incorrect']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @cp_activation.nil?
+      return false if @data_last_seen.nil?
+      return false if @filters_configured.nil?
+      return false if @integration_installed_status.nil?
+      return false if @logs_seen_from_any_index.nil?
+      return false if @siem_index_incorrect.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param cp_activation [Object] Object to be assigned
+    # @!visibility private
+    def cp_activation=(cp_activation)
+      if cp_activation.nil?
+        fail ArgumentError, 'invalid value for "cp_activation", cp_activation cannot be nil.'
+      end
+      @cp_activation = cp_activation
+    end
+
+    # Custom attribute writer method with validation
+    # @param data_last_seen [Object] Object to be assigned
+    # @!visibility private
+    def data_last_seen=(data_last_seen)
+      if data_last_seen.nil?
+        fail ArgumentError, 'invalid value for "data_last_seen", data_last_seen cannot be nil.'
+      end
+      @data_last_seen = data_last_seen
+    end
+
+    # Custom attribute writer method with validation
+    # @param filters_configured [Object] Object to be assigned
+    # @!visibility private
+    def filters_configured=(filters_configured)
+      if filters_configured.nil?
+        fail ArgumentError, 'invalid value for "filters_configured", filters_configured cannot be nil.'
+      end
+      @filters_configured = filters_configured
+    end
+
+    # Custom attribute writer method with validation
+    # @param integration_installed_status [Object] Object to be assigned
+    # @!visibility private
+    def integration_installed_status=(integration_installed_status)
+      if integration_installed_status.nil?
+        fail ArgumentError, 'invalid value for "integration_installed_status", integration_installed_status cannot be nil.'
+      end
+      @integration_installed_status = integration_installed_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param logs_seen_from_any_index [Object] Object to be assigned
+    # @!visibility private
+    def logs_seen_from_any_index=(logs_seen_from_any_index)
+      if logs_seen_from_any_index.nil?
+        fail ArgumentError, 'invalid value for "logs_seen_from_any_index", logs_seen_from_any_index cannot be nil.'
+      end
+      @logs_seen_from_any_index = logs_seen_from_any_index
+    end
+
+    # Custom attribute writer method with validation
+    # @param siem_index_incorrect [Object] Object to be assigned
+    # @!visibility private
+    def siem_index_incorrect=(siem_index_incorrect)
+      if siem_index_incorrect.nil?
+        fail ArgumentError, 'invalid value for "siem_index_incorrect", siem_index_incorrect cannot be nil.'
+      end
+      @siem_index_incorrect = siem_index_incorrect
+    end
+
+    # Custom attribute writer method with validation
+    # @param type [Object] Object to be assigned
+    # @!visibility private
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'invalid value for "type", type cannot be nil.'
+      end
+      @type = 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
+    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 &&
+          cp_activation == o.cp_activation &&
+          data_last_seen == o.data_last_seen &&
+          filters_configured == o.filters_configured &&
+          integration_installed_status == o.integration_installed_status &&
+          logs_seen_from_any_index == o.logs_seen_from_any_index &&
+          siem_index_incorrect == o.siem_index_incorrect &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [cp_activation, data_last_seen, filters_configured, integration_installed_status, logs_seen_from_any_index, siem_index_incorrect, type, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,154 @@
+=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
+  # Content pack details returned when Cloud SIEM is inactive for the requesting organization.
+  class SecurityMonitoringContentPackOnboardingDetails
+    include BaseGenericModel
+
+    # The installation status of the related integration.
+    attr_accessor :integration_installed_status
+
+    # Whether logs for this content pack have been seen in any Datadog index in the last 72 hours.
+    attr_reader :logs_seen_from_any_index
+
+    # Type for onboarding content pack details.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'integration_installed_status' => :'integration_installed_status',
+        :'logs_seen_from_any_index' => :'logs_seen_from_any_index',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'integration_installed_status' => :'SecurityMonitoringContentPackIntegrationStatus',
+        :'logs_seen_from_any_index' => :'Boolean',
+        :'type' => :'SecurityMonitoringContentPackOnboardingDetailsType'
+      }
+    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::SecurityMonitoringContentPackOnboardingDetails` 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?(:'integration_installed_status')
+        self.integration_installed_status = attributes[:'integration_installed_status']
+      end
+
+      if attributes.key?(:'logs_seen_from_any_index')
+        self.logs_seen_from_any_index = attributes[:'logs_seen_from_any_index']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      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 @logs_seen_from_any_index.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param logs_seen_from_any_index [Object] Object to be assigned
+    # @!visibility private
+    def logs_seen_from_any_index=(logs_seen_from_any_index)
+      if logs_seen_from_any_index.nil?
+        fail ArgumentError, 'invalid value for "logs_seen_from_any_index", logs_seen_from_any_index cannot be nil.'
+      end
+      @logs_seen_from_any_index = logs_seen_from_any_index
+    end
+
+    # Custom attribute writer method with validation
+    # @param type [Object] Object to be assigned
+    # @!visibility private
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'invalid value for "type", type cannot be nil.'
+      end
+      @type = 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
+    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 &&
+          integration_installed_status == o.integration_installed_status &&
+          logs_seen_from_any_index == o.logs_seen_from_any_index &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [integration_installed_status, logs_seen_from_any_index, type, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/security_monitoring_content_pack_onboarding_details_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
+  # Type for onboarding content pack details.
+  class SecurityMonitoringContentPackOnboardingDetailsType
+    include BaseEnumModel
+
+    ONBOARDING = "onboarding".freeze
+  end
+end

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

@@ -17,31 +17,16 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Attributes of a content pack state
+  # Attributes of a content pack state.
   class SecurityMonitoringContentPackStateAttributes
     include BaseGenericModel
 
-    # Whether the cloud SIEM index configuration is incorrect (only applies to certain pricing models)
-    attr_reader :cloud_siem_index_incorrect
-
-    # The activation status of a content pack.
-    attr_reader :cp_activation
-
-    # Whether filters (Security Filters or Index Query depending on the pricing model) are
-    # present and correctly configured to route logs into Cloud SIEM.
-    attr_reader :filters_configured_for_logs
-
-    # The installation status of the related integration.
-    attr_accessor :integration_installed_status
-
-    # Timestamp bucket indicating when logs were last collected.
-    attr_reader :logs_last_collected
-
-    # Whether logs for this content pack have been seen in any Datadog index within the last 72 hours.
-    attr_reader :logs_seen_from_any_index
+    # Type-specific details for a content pack state. The set of fields present depends
+    # on the content pack's `type`. When Cloud SIEM is inactive for the requesting organization, `onboarding` is returned instead of the content pack's usual type, such as `logs` or `vulnerability`.`
+    attr_reader :details
 
     # The current operational status of a content pack.
-    attr_reader :state
+    attr_reader :status
 
     attr_accessor :additional_properties
 
@@ -49,13 +34,8 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.attribute_map
       {
-        :'cloud_siem_index_incorrect' => :'cloud_siem_index_incorrect',
-        :'cp_activation' => :'cp_activation',
-        :'filters_configured_for_logs' => :'filters_configured_for_logs',
-        :'integration_installed_status' => :'integration_installed_status',
-        :'logs_last_collected' => :'logs_last_collected',
-        :'logs_seen_from_any_index' => :'logs_seen_from_any_index',
-        :'state' => :'state'
+        :'details' => :'details',
+        :'status' => :'status'
       }
     end
 
@@ -63,13 +43,8 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
-        :'cloud_siem_index_incorrect' => :'Boolean',
-        :'cp_activation' => :'SecurityMonitoringContentPackActivation',
-        :'filters_configured_for_logs' => :'Boolean',
-        :'integration_installed_status' => :'SecurityMonitoringContentPackIntegrationStatus',
-        :'logs_last_collected' => :'SecurityMonitoringContentPackTimestampBucket',
-        :'logs_seen_from_any_index' => :'Boolean',
-        :'state' => :'SecurityMonitoringContentPackStatus'
+        :'details' => :'SecurityMonitoringContentPackStateDetails',
+        :'status' => :'SecurityMonitoringContentPackStatus'
       }
     end
 
@@ -91,32 +66,12 @@ module DatadogAPIClient::V2
         end
       }
 
-      if attributes.key?(:'cloud_siem_index_incorrect')
-        self.cloud_siem_index_incorrect = attributes[:'cloud_siem_index_incorrect']
-      end
-
-      if attributes.key?(:'cp_activation')
-        self.cp_activation = attributes[:'cp_activation']
-      end
-
-      if attributes.key?(:'filters_configured_for_logs')
-        self.filters_configured_for_logs = attributes[:'filters_configured_for_logs']
+      if attributes.key?(:'details')
+        self.details = attributes[:'details']
       end
 
-      if attributes.key?(:'integration_installed_status')
-        self.integration_installed_status = attributes[:'integration_installed_status']
-      end
-
-      if attributes.key?(:'logs_last_collected')
-        self.logs_last_collected = attributes[:'logs_last_collected']
-      end
-
-      if attributes.key?(:'logs_seen_from_any_index')
-        self.logs_seen_from_any_index = attributes[:'logs_seen_from_any_index']
-      end
-
-      if attributes.key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
       end
     end
 
@@ -124,73 +79,29 @@ module DatadogAPIClient::V2
     # @return true if the model is valid
     # @!visibility private
     def valid?
-      return false if @cloud_siem_index_incorrect.nil?
-      return false if @cp_activation.nil?
-      return false if @filters_configured_for_logs.nil?
-      return false if @logs_last_collected.nil?
-      return false if @logs_seen_from_any_index.nil?
-      return false if @state.nil?
+      return false if @details.nil?
+      return false if @status.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param cloud_siem_index_incorrect [Object] Object to be assigned
-    # @!visibility private
-    def cloud_siem_index_incorrect=(cloud_siem_index_incorrect)
-      if cloud_siem_index_incorrect.nil?
-        fail ArgumentError, 'invalid value for "cloud_siem_index_incorrect", cloud_siem_index_incorrect cannot be nil.'
-      end
-      @cloud_siem_index_incorrect = cloud_siem_index_incorrect
-    end
-
-    # Custom attribute writer method with validation
-    # @param cp_activation [Object] Object to be assigned
-    # @!visibility private
-    def cp_activation=(cp_activation)
-      if cp_activation.nil?
-        fail ArgumentError, 'invalid value for "cp_activation", cp_activation cannot be nil.'
-      end
-      @cp_activation = cp_activation
-    end
-
-    # Custom attribute writer method with validation
-    # @param filters_configured_for_logs [Object] Object to be assigned
-    # @!visibility private
-    def filters_configured_for_logs=(filters_configured_for_logs)
-      if filters_configured_for_logs.nil?
-        fail ArgumentError, 'invalid value for "filters_configured_for_logs", filters_configured_for_logs cannot be nil.'
-      end
-      @filters_configured_for_logs = filters_configured_for_logs
-    end
-
-    # Custom attribute writer method with validation
-    # @param logs_last_collected [Object] Object to be assigned
-    # @!visibility private
-    def logs_last_collected=(logs_last_collected)
-      if logs_last_collected.nil?
-        fail ArgumentError, 'invalid value for "logs_last_collected", logs_last_collected cannot be nil.'
-      end
-      @logs_last_collected = logs_last_collected
-    end
-
-    # Custom attribute writer method with validation
-    # @param logs_seen_from_any_index [Object] Object to be assigned
+    # @param details [Object] Object to be assigned
     # @!visibility private
-    def logs_seen_from_any_index=(logs_seen_from_any_index)
-      if logs_seen_from_any_index.nil?
-        fail ArgumentError, 'invalid value for "logs_seen_from_any_index", logs_seen_from_any_index cannot be nil.'
+    def details=(details)
+      if details.nil?
+        fail ArgumentError, 'invalid value for "details", details cannot be nil.'
       end
-      @logs_seen_from_any_index = logs_seen_from_any_index
+      @details = details
     end
 
     # Custom attribute writer method with validation
-    # @param state [Object] Object to be assigned
+    # @param status [Object] Object to be assigned
     # @!visibility private
-    def state=(state)
-      if state.nil?
-        fail ArgumentError, 'invalid value for "state", state cannot be nil.'
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'invalid value for "status", status cannot be nil.'
       end
-      @state = state
+      @status = status
     end
 
     # Returns the object in the form of hash, with additionalProperties support.
@@ -219,13 +130,8 @@ module DatadogAPIClient::V2
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          cloud_siem_index_incorrect == o.cloud_siem_index_incorrect &&
-          cp_activation == o.cp_activation &&
-          filters_configured_for_logs == o.filters_configured_for_logs &&
-          integration_installed_status == o.integration_installed_status &&
-          logs_last_collected == o.logs_last_collected &&
-          logs_seen_from_any_index == o.logs_seen_from_any_index &&
-          state == o.state &&
+          details == o.details &&
+          status == o.status &&
           additional_properties == o.additional_properties
     end
 
@@ -233,7 +139,7 @@ module DatadogAPIClient::V2
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [cloud_siem_index_incorrect, cp_activation, filters_configured_for_logs, integration_installed_status, logs_last_collected, logs_seen_from_any_index, state, additional_properties].hash
+      [details, status, additional_properties].hash
     end
   end
 end

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

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class SecurityMonitoringContentPackStateData
     include BaseGenericModel
 
-    # Attributes of a content pack state
+    # Attributes of a content pack state.
     attr_reader :attributes
 
     # The content pack identifier.