datadog_api_client 2.54.0 → 2.56.0

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

@@ -0,0 +1,739 @@
+=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 attributes of a governance control.
+  class GovernanceControlAttributes
+    include BaseGenericModel
+
+    # The number of active detections for the control.
+    attr_reader :active_detections_count
+
+    # The value driver the control is grouped under, such as `security` or `cost`.
+    attr_reader :category
+
+    # The time the control configuration was created.
+    attr_reader :created_at
+
+    # The UUID of the user who created the control configuration.
+    attr_reader :created_by
+
+    # A human-readable description of what the control detects.
+    attr_reader :description
+
+    # How often detections are evaluated for the control.
+    attr_reader :detection_frequency
+
+    # A free-form map of parameter names to their configured values.
+    attr_reader :detection_parameters
+
+    # The detection type that uniquely identifies the control.
+    attr_reader :detection_type
+
+    # The feature flags that gate the control.
+    attr_reader :feature_flags
+
+    # The insight slugs associated with the control.
+    attr_reader :insights
+
+    # The time of the most recent detection for the control. `null` when there are no detections.
+    attr_accessor :last_detection_at
+
+    # The number of mitigated detections for the control.
+    attr_reader :mitigated_detections_count
+
+    # A free-form map of parameter names to their configured values.
+    attr_reader :mitigation_parameters
+
+    # The configured mitigation type for the control. Empty when not configured.
+    attr_reader :mitigation_type
+
+    # The mitigations available for a control.
+    attr_reader :mitigations
+
+    # Human-readable name of the control.
+    attr_reader :name
+
+    # Guidance on the next steps to remediate detections for the control.
+    attr_reader :next_steps
+
+    # The configured notification frequency for the control. Empty when not configured.
+    attr_reader :notification_frequency
+
+    # A free-form map of parameter names to their configured values.
+    attr_reader :notification_parameters
+
+    # The configured notification type for the control. Empty when not configured.
+    attr_reader :notification_type
+
+    # The priority of the control, such as `High`.
+    attr_reader :priority
+
+    # The product the control belongs to.
+    attr_reader :product
+
+    # The release status of the control, such as `prod` or `beta`.
+    attr_reader :release_status
+
+    # The type of resource the control evaluates.
+    attr_reader :resource_type
+
+    # The human-readable name of the resource type.
+    attr_reader :resource_type_display_name
+
+    # An array of parameter definitions.
+    attr_reader :supported_detection_parameters
+
+    # An array of parameter definitions.
+    attr_reader :supported_notification_parameters
+
+    # A short description of the remediation task for the control.
+    attr_reader :task
+
+    # The control type, such as `Proactive` or `Detection`.
+    attr_reader :type
+
+    # The usage concern the control addresses, such as `Security` or `Cost Optimization`.
+    attr_reader :usage_concern
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'active_detections_count' => :'active_detections_count',
+        :'category' => :'category',
+        :'created_at' => :'created_at',
+        :'created_by' => :'created_by',
+        :'description' => :'description',
+        :'detection_frequency' => :'detection_frequency',
+        :'detection_parameters' => :'detection_parameters',
+        :'detection_type' => :'detection_type',
+        :'feature_flags' => :'feature_flags',
+        :'insights' => :'insights',
+        :'last_detection_at' => :'last_detection_at',
+        :'mitigated_detections_count' => :'mitigated_detections_count',
+        :'mitigation_parameters' => :'mitigation_parameters',
+        :'mitigation_type' => :'mitigation_type',
+        :'mitigations' => :'mitigations',
+        :'name' => :'name',
+        :'next_steps' => :'next_steps',
+        :'notification_frequency' => :'notification_frequency',
+        :'notification_parameters' => :'notification_parameters',
+        :'notification_type' => :'notification_type',
+        :'priority' => :'priority',
+        :'product' => :'product',
+        :'release_status' => :'release_status',
+        :'resource_type' => :'resource_type',
+        :'resource_type_display_name' => :'resource_type_display_name',
+        :'supported_detection_parameters' => :'supported_detection_parameters',
+        :'supported_notification_parameters' => :'supported_notification_parameters',
+        :'task' => :'task',
+        :'type' => :'type',
+        :'usage_concern' => :'usage_concern'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'active_detections_count' => :'Integer',
+        :'category' => :'String',
+        :'created_at' => :'Time',
+        :'created_by' => :'String',
+        :'description' => :'String',
+        :'detection_frequency' => :'String',
+        :'detection_parameters' => :'Hash<String, Object>',
+        :'detection_type' => :'String',
+        :'feature_flags' => :'Array<String>',
+        :'insights' => :'Array<String>',
+        :'last_detection_at' => :'Time',
+        :'mitigated_detections_count' => :'Integer',
+        :'mitigation_parameters' => :'Hash<String, Object>',
+        :'mitigation_type' => :'String',
+        :'mitigations' => :'Array<GovernanceControlMitigationDefinition>',
+        :'name' => :'String',
+        :'next_steps' => :'String',
+        :'notification_frequency' => :'String',
+        :'notification_parameters' => :'Hash<String, Object>',
+        :'notification_type' => :'String',
+        :'priority' => :'String',
+        :'product' => :'String',
+        :'release_status' => :'String',
+        :'resource_type' => :'String',
+        :'resource_type_display_name' => :'String',
+        :'supported_detection_parameters' => :'Array<GovernanceControlParameterDefinition>',
+        :'supported_notification_parameters' => :'Array<GovernanceControlParameterDefinition>',
+        :'task' => :'String',
+        :'type' => :'String',
+        :'usage_concern' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    # @!visibility private
+    def self.openapi_nullable
+      Set.new([
+        :'last_detection_at',
+      ])
+    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::GovernanceControlAttributes` 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?(:'active_detections_count')
+        self.active_detections_count = attributes[:'active_detections_count']
+      end
+
+      if attributes.key?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'detection_frequency')
+        self.detection_frequency = attributes[:'detection_frequency']
+      end
+
+      if attributes.key?(:'detection_parameters')
+        self.detection_parameters = attributes[:'detection_parameters']
+      end
+
+      if attributes.key?(:'detection_type')
+        self.detection_type = attributes[:'detection_type']
+      end
+
+      if attributes.key?(:'feature_flags')
+        if (value = attributes[:'feature_flags']).is_a?(Array)
+          self.feature_flags = value
+        end
+      end
+
+      if attributes.key?(:'insights')
+        if (value = attributes[:'insights']).is_a?(Array)
+          self.insights = value
+        end
+      end
+
+      if attributes.key?(:'last_detection_at')
+        self.last_detection_at = attributes[:'last_detection_at']
+      end
+
+      if attributes.key?(:'mitigated_detections_count')
+        self.mitigated_detections_count = attributes[:'mitigated_detections_count']
+      end
+
+      if attributes.key?(:'mitigation_parameters')
+        self.mitigation_parameters = attributes[:'mitigation_parameters']
+      end
+
+      if attributes.key?(:'mitigation_type')
+        self.mitigation_type = attributes[:'mitigation_type']
+      end
+
+      if attributes.key?(:'mitigations')
+        if (value = attributes[:'mitigations']).is_a?(Array)
+          self.mitigations = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'next_steps')
+        self.next_steps = attributes[:'next_steps']
+      end
+
+      if attributes.key?(:'notification_frequency')
+        self.notification_frequency = attributes[:'notification_frequency']
+      end
+
+      if attributes.key?(:'notification_parameters')
+        self.notification_parameters = attributes[:'notification_parameters']
+      end
+
+      if attributes.key?(:'notification_type')
+        self.notification_type = attributes[:'notification_type']
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
+      end
+
+      if attributes.key?(:'release_status')
+        self.release_status = attributes[:'release_status']
+      end
+
+      if attributes.key?(:'resource_type')
+        self.resource_type = attributes[:'resource_type']
+      end
+
+      if attributes.key?(:'resource_type_display_name')
+        self.resource_type_display_name = attributes[:'resource_type_display_name']
+      end
+
+      if attributes.key?(:'supported_detection_parameters')
+        if (value = attributes[:'supported_detection_parameters']).is_a?(Array)
+          self.supported_detection_parameters = value
+        end
+      end
+
+      if attributes.key?(:'supported_notification_parameters')
+        if (value = attributes[:'supported_notification_parameters']).is_a?(Array)
+          self.supported_notification_parameters = value
+        end
+      end
+
+      if attributes.key?(:'task')
+        self.task = attributes[:'task']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'usage_concern')
+        self.usage_concern = attributes[:'usage_concern']
+      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 @active_detections_count.nil?
+      return false if @category.nil?
+      return false if @created_at.nil?
+      return false if @created_by.nil?
+      return false if @description.nil?
+      return false if @detection_frequency.nil?
+      return false if @detection_parameters.nil?
+      return false if @detection_type.nil?
+      return false if @feature_flags.nil?
+      return false if @insights.nil?
+      return false if @mitigated_detections_count.nil?
+      return false if @mitigation_parameters.nil?
+      return false if @mitigation_type.nil?
+      return false if @mitigations.nil?
+      return false if @name.nil?
+      return false if @next_steps.nil?
+      return false if @notification_frequency.nil?
+      return false if @notification_parameters.nil?
+      return false if @notification_type.nil?
+      return false if @priority.nil?
+      return false if @product.nil?
+      return false if @release_status.nil?
+      return false if @resource_type.nil?
+      return false if @resource_type_display_name.nil?
+      return false if @supported_detection_parameters.nil?
+      return false if @supported_notification_parameters.nil?
+      return false if @task.nil?
+      return false if @type.nil?
+      return false if @usage_concern.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param active_detections_count [Object] Object to be assigned
+    # @!visibility private
+    def active_detections_count=(active_detections_count)
+      if active_detections_count.nil?
+        fail ArgumentError, 'invalid value for "active_detections_count", active_detections_count cannot be nil.'
+      end
+      @active_detections_count = active_detections_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param category [Object] Object to be assigned
+    # @!visibility private
+    def category=(category)
+      if category.nil?
+        fail ArgumentError, 'invalid value for "category", category cannot be nil.'
+      end
+      @category = category
+    end
+
+    # Custom attribute writer method with validation
+    # @param created_at [Object] Object to be assigned
+    # @!visibility private
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'invalid value for "created_at", created_at cannot be nil.'
+      end
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param created_by [Object] Object to be assigned
+    # @!visibility private
+    def created_by=(created_by)
+      if created_by.nil?
+        fail ArgumentError, 'invalid value for "created_by", created_by cannot be nil.'
+      end
+      @created_by = created_by
+    end
+
+    # Custom attribute writer method with validation
+    # @param description [Object] Object to be assigned
+    # @!visibility private
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'invalid value for "description", description cannot be nil.'
+      end
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param detection_frequency [Object] Object to be assigned
+    # @!visibility private
+    def detection_frequency=(detection_frequency)
+      if detection_frequency.nil?
+        fail ArgumentError, 'invalid value for "detection_frequency", detection_frequency cannot be nil.'
+      end
+      @detection_frequency = detection_frequency
+    end
+
+    # Custom attribute writer method with validation
+    # @param detection_parameters [Object] Object to be assigned
+    # @!visibility private
+    def detection_parameters=(detection_parameters)
+      if detection_parameters.nil?
+        fail ArgumentError, 'invalid value for "detection_parameters", detection_parameters cannot be nil.'
+      end
+      @detection_parameters = detection_parameters
+    end
+
+    # Custom attribute writer method with validation
+    # @param detection_type [Object] Object to be assigned
+    # @!visibility private
+    def detection_type=(detection_type)
+      if detection_type.nil?
+        fail ArgumentError, 'invalid value for "detection_type", detection_type cannot be nil.'
+      end
+      @detection_type = detection_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param feature_flags [Object] Object to be assigned
+    # @!visibility private
+    def feature_flags=(feature_flags)
+      if feature_flags.nil?
+        fail ArgumentError, 'invalid value for "feature_flags", feature_flags cannot be nil.'
+      end
+      @feature_flags = feature_flags
+    end
+
+    # Custom attribute writer method with validation
+    # @param insights [Object] Object to be assigned
+    # @!visibility private
+    def insights=(insights)
+      if insights.nil?
+        fail ArgumentError, 'invalid value for "insights", insights cannot be nil.'
+      end
+      @insights = insights
+    end
+
+    # Custom attribute writer method with validation
+    # @param mitigated_detections_count [Object] Object to be assigned
+    # @!visibility private
+    def mitigated_detections_count=(mitigated_detections_count)
+      if mitigated_detections_count.nil?
+        fail ArgumentError, 'invalid value for "mitigated_detections_count", mitigated_detections_count cannot be nil.'
+      end
+      @mitigated_detections_count = mitigated_detections_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param mitigation_parameters [Object] Object to be assigned
+    # @!visibility private
+    def mitigation_parameters=(mitigation_parameters)
+      if mitigation_parameters.nil?
+        fail ArgumentError, 'invalid value for "mitigation_parameters", mitigation_parameters cannot be nil.'
+      end
+      @mitigation_parameters = mitigation_parameters
+    end
+
+    # Custom attribute writer method with validation
+    # @param mitigation_type [Object] Object to be assigned
+    # @!visibility private
+    def mitigation_type=(mitigation_type)
+      if mitigation_type.nil?
+        fail ArgumentError, 'invalid value for "mitigation_type", mitigation_type cannot be nil.'
+      end
+      @mitigation_type = mitigation_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param mitigations [Object] Object to be assigned
+    # @!visibility private
+    def mitigations=(mitigations)
+      if mitigations.nil?
+        fail ArgumentError, 'invalid value for "mitigations", mitigations cannot be nil.'
+      end
+      @mitigations = mitigations
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param next_steps [Object] Object to be assigned
+    # @!visibility private
+    def next_steps=(next_steps)
+      if next_steps.nil?
+        fail ArgumentError, 'invalid value for "next_steps", next_steps cannot be nil.'
+      end
+      @next_steps = next_steps
+    end
+
+    # Custom attribute writer method with validation
+    # @param notification_frequency [Object] Object to be assigned
+    # @!visibility private
+    def notification_frequency=(notification_frequency)
+      if notification_frequency.nil?
+        fail ArgumentError, 'invalid value for "notification_frequency", notification_frequency cannot be nil.'
+      end
+      @notification_frequency = notification_frequency
+    end
+
+    # Custom attribute writer method with validation
+    # @param notification_parameters [Object] Object to be assigned
+    # @!visibility private
+    def notification_parameters=(notification_parameters)
+      if notification_parameters.nil?
+        fail ArgumentError, 'invalid value for "notification_parameters", notification_parameters cannot be nil.'
+      end
+      @notification_parameters = notification_parameters
+    end
+
+    # Custom attribute writer method with validation
+    # @param notification_type [Object] Object to be assigned
+    # @!visibility private
+    def notification_type=(notification_type)
+      if notification_type.nil?
+        fail ArgumentError, 'invalid value for "notification_type", notification_type cannot be nil.'
+      end
+      @notification_type = notification_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param priority [Object] Object to be assigned
+    # @!visibility private
+    def priority=(priority)
+      if priority.nil?
+        fail ArgumentError, 'invalid value for "priority", priority cannot be nil.'
+      end
+      @priority = priority
+    end
+
+    # Custom attribute writer method with validation
+    # @param product [Object] Object to be assigned
+    # @!visibility private
+    def product=(product)
+      if product.nil?
+        fail ArgumentError, 'invalid value for "product", product cannot be nil.'
+      end
+      @product = product
+    end
+
+    # Custom attribute writer method with validation
+    # @param release_status [Object] Object to be assigned
+    # @!visibility private
+    def release_status=(release_status)
+      if release_status.nil?
+        fail ArgumentError, 'invalid value for "release_status", release_status cannot be nil.'
+      end
+      @release_status = release_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param resource_type [Object] Object to be assigned
+    # @!visibility private
+    def resource_type=(resource_type)
+      if resource_type.nil?
+        fail ArgumentError, 'invalid value for "resource_type", resource_type cannot be nil.'
+      end
+      @resource_type = resource_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param resource_type_display_name [Object] Object to be assigned
+    # @!visibility private
+    def resource_type_display_name=(resource_type_display_name)
+      if resource_type_display_name.nil?
+        fail ArgumentError, 'invalid value for "resource_type_display_name", resource_type_display_name cannot be nil.'
+      end
+      @resource_type_display_name = resource_type_display_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param supported_detection_parameters [Object] Object to be assigned
+    # @!visibility private
+    def supported_detection_parameters=(supported_detection_parameters)
+      if supported_detection_parameters.nil?
+        fail ArgumentError, 'invalid value for "supported_detection_parameters", supported_detection_parameters cannot be nil.'
+      end
+      @supported_detection_parameters = supported_detection_parameters
+    end
+
+    # Custom attribute writer method with validation
+    # @param supported_notification_parameters [Object] Object to be assigned
+    # @!visibility private
+    def supported_notification_parameters=(supported_notification_parameters)
+      if supported_notification_parameters.nil?
+        fail ArgumentError, 'invalid value for "supported_notification_parameters", supported_notification_parameters cannot be nil.'
+      end
+      @supported_notification_parameters = supported_notification_parameters
+    end
+
+    # Custom attribute writer method with validation
+    # @param task [Object] Object to be assigned
+    # @!visibility private
+    def task=(task)
+      if task.nil?
+        fail ArgumentError, 'invalid value for "task", task cannot be nil.'
+      end
+      @task = task
+    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
+
+    # Custom attribute writer method with validation
+    # @param usage_concern [Object] Object to be assigned
+    # @!visibility private
+    def usage_concern=(usage_concern)
+      if usage_concern.nil?
+        fail ArgumentError, 'invalid value for "usage_concern", usage_concern cannot be nil.'
+      end
+      @usage_concern = usage_concern
+    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 &&
+          active_detections_count == o.active_detections_count &&
+          category == o.category &&
+          created_at == o.created_at &&
+          created_by == o.created_by &&
+          description == o.description &&
+          detection_frequency == o.detection_frequency &&
+          detection_parameters == o.detection_parameters &&
+          detection_type == o.detection_type &&
+          feature_flags == o.feature_flags &&
+          insights == o.insights &&
+          last_detection_at == o.last_detection_at &&
+          mitigated_detections_count == o.mitigated_detections_count &&
+          mitigation_parameters == o.mitigation_parameters &&
+          mitigation_type == o.mitigation_type &&
+          mitigations == o.mitigations &&
+          name == o.name &&
+          next_steps == o.next_steps &&
+          notification_frequency == o.notification_frequency &&
+          notification_parameters == o.notification_parameters &&
+          notification_type == o.notification_type &&
+          priority == o.priority &&
+          product == o.product &&
+          release_status == o.release_status &&
+          resource_type == o.resource_type &&
+          resource_type_display_name == o.resource_type_display_name &&
+          supported_detection_parameters == o.supported_detection_parameters &&
+          supported_notification_parameters == o.supported_notification_parameters &&
+          task == o.task &&
+          type == o.type &&
+          usage_concern == o.usage_concern &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [active_detections_count, category, created_at, created_by, description, detection_frequency, detection_parameters, detection_type, feature_flags, insights, last_detection_at, mitigated_detections_count, mitigation_parameters, mitigation_type, mitigations, name, next_steps, notification_frequency, notification_parameters, notification_type, priority, product, release_status, resource_type, resource_type_display_name, supported_detection_parameters, supported_notification_parameters, task, type, usage_concern, additional_properties].hash
+    end
+  end
+end