datadog_api_client 2.52.0 → 2.53.0

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

@@ -24,22 +24,23 @@ module DatadogAPIClient::V2
     # 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
+    # The activation status of a content pack.
     attr_reader :cp_activation
 
-    # Whether filters (Security Filters or Index Query depending on the pricing model) are configured for logs
+    # 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
+    # The installation status of the related integration.
     attr_accessor :integration_installed_status
 
-    # Timestamp bucket indicating when logs were last collected
+    # Timestamp bucket indicating when logs were last collected.
     attr_reader :logs_last_collected
 
-    # Whether logs have been seen from any index
+    # 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
 
-    # The current status of a content pack
+    # The current operational status of a content pack.
     attr_reader :state
 
     attr_accessor :additional_properties

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

@@ -24,7 +24,7 @@ module DatadogAPIClient::V2
     # Whether the cloud SIEM index configuration is incorrect at the organization level
     attr_reader :cloud_siem_index_incorrect
 
-    # The SIEM pricing model (SKU) for the organization
+    # The Cloud SIEM pricing model (SKU) for the organization.
     attr_reader :sku
 
     attr_accessor :additional_properties

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The current status of a content pack
+  # The current operational status of a content pack.
   class SecurityMonitoringContentPackStatus
     include BaseEnumModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Timestamp bucket indicating when logs were last collected
+  # Timestamp bucket indicating when logs were last collected.
   class SecurityMonitoringContentPackTimestampBucket
     include BaseEnumModel
 

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

@@ -0,0 +1,165 @@
+=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 suggested action for a security signal.
+  class SecurityMonitoringSignalSuggestedAction
+    include BaseGenericModel
+
+    # Attributes of a suggested action for a security signal. The available fields depend on the action type.
+    attr_reader :attributes
+
+    # The unique ID of the suggested action.
+    attr_reader :id
+
+    # The type of the suggested action resource.
+    attr_reader :type
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'attributes' => :'attributes',
+        :'id' => :'id',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'attributes' => :'SecurityMonitoringSignalSuggestedActionAttributes',
+        :'id' => :'String',
+        :'type' => :'SecurityMonitoringSignalSuggestedActionType'
+      }
+    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::SecurityMonitoringSignalSuggestedAction` 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?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      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 @attributes.nil?
+      return false if @id.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param attributes [Object] Object to be assigned
+    # @!visibility private
+    def attributes=(attributes)
+      if attributes.nil?
+        fail ArgumentError, 'invalid value for "attributes", attributes cannot be nil.'
+      end
+      @attributes = attributes
+    end
+
+    # Custom attribute writer method with validation
+    # @param id [Object] Object to be assigned
+    # @!visibility private
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'invalid value for "id", id cannot be nil.'
+      end
+      @id = id
+    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 &&
+          attributes == o.attributes &&
+          id == o.id &&
+          type == o.type &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [attributes, id, type, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,145 @@
+=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
+  # Attributes of a suggested action for a security signal. The available fields depend on the action type.
+  class SecurityMonitoringSignalSuggestedActionAttributes
+    include BaseGenericModel
+
+    # The name of the investigation log query.
+    attr_accessor :name
+
+    # The log query filter for the investigation.
+    attr_accessor :query_filter
+
+    # Template variables applied to the investigation log query, mapping attribute paths to values extracted from the signal.
+    attr_accessor :template_variables
+
+    # The title of the recommended blog post.
+    attr_accessor :title
+
+    # The URL of the suggested action.
+    attr_accessor :url
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'query_filter' => :'query_filter',
+        :'template_variables' => :'template_variables',
+        :'title' => :'title',
+        :'url' => :'url'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'query_filter' => :'String',
+        :'template_variables' => :'Hash<String, Array<String>>',
+        :'title' => :'String',
+        :'url' => :'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::SecurityMonitoringSignalSuggestedActionAttributes` 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'query_filter')
+        self.query_filter = attributes[:'query_filter']
+      end
+
+      if attributes.key?(:'template_variables')
+        self.template_variables = attributes[:'template_variables']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+    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 &&
+          name == o.name &&
+          query_filter == o.query_filter &&
+          template_variables == o.template_variables &&
+          title == o.title &&
+          url == o.url &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [name, query_filter, template_variables, title, url, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+=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 the suggested action resource.
+  class SecurityMonitoringSignalSuggestedActionType
+    include BaseEnumModel
+
+    INVESTIGATION_LOG_QUERIES = "investigation_log_queries".freeze
+    RECOMMENDED_BLOG_POSTS = "recommended_blog_posts".freeze
+  end
+end

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

@@ -0,0 +1,125 @@
+=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
+  # Response with suggested actions for a security signal.
+  class SecurityMonitoringSignalSuggestedActionsResponse
+    include BaseGenericModel
+
+    # List of suggested actions for a security signal.
+    attr_reader :data
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data' => :'Array<SecurityMonitoringSignalSuggestedAction>'
+      }
+    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::SecurityMonitoringSignalSuggestedActionsResponse` 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param data [Object] Object to be assigned
+    # @!visibility private
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'invalid value for "data", data cannot be nil.'
+      end
+      @data = data
+    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 &&
+          data == o.data &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,145 @@
+=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
+  # Attributes for updating the triage state or assignee of a security signal.
+  class SecurityMonitoringSignalUpdateAttributes
+    include BaseGenericModel
+
+    # Optional comment to display on archived signals.
+    attr_accessor :archive_comment
+
+    # Reason a signal is archived.
+    attr_accessor :archive_reason
+
+    # Object representing a given user entity.
+    attr_accessor :assignee
+
+    # The new triage state of the signal.
+    attr_accessor :state
+
+    # Version of the updated signal. If server side version is higher, update will be rejected.
+    attr_accessor :version
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'archive_comment' => :'archive_comment',
+        :'archive_reason' => :'archive_reason',
+        :'assignee' => :'assignee',
+        :'state' => :'state',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'archive_comment' => :'String',
+        :'archive_reason' => :'SecurityMonitoringSignalArchiveReason',
+        :'assignee' => :'SecurityMonitoringTriageUser',
+        :'state' => :'SecurityMonitoringSignalState',
+        :'version' => :'Integer'
+      }
+    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::SecurityMonitoringSignalUpdateAttributes` 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?(:'archive_comment')
+        self.archive_comment = attributes[:'archive_comment']
+      end
+
+      if attributes.key?(:'archive_reason')
+        self.archive_reason = attributes[:'archive_reason']
+      end
+
+      if attributes.key?(:'assignee')
+        self.assignee = attributes[:'assignee']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
+    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 &&
+          archive_comment == o.archive_comment &&
+          archive_reason == o.archive_reason &&
+          assignee == o.assignee &&
+          state == o.state &&
+          version == o.version &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [archive_comment, archive_reason, assignee, state, version, additional_properties].hash
+    end
+  end
+end