datadog_api_client 2.29.1 → 2.30.0

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

@@ -0,0 +1,311 @@
+=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 the notification rule.
+  class NotificationRuleAttributes
+    include BaseGenericModel
+
+    # Date as Unix timestamp in milliseconds.
+    attr_reader :created_at
+
+    # User creating or modifying a rule.
+    attr_reader :created_by
+
+    # Field used to enable or disable the rule.
+    attr_reader :enabled
+
+    # Date as Unix timestamp in milliseconds.
+    attr_reader :modified_at
+
+    # User creating or modifying a rule.
+    attr_reader :modified_by
+
+    # Name of the notification rule.
+    attr_reader :name
+
+    # Selectors are used to filter security issues for which notifications should be generated.
+    # Users can specify rule severities, rule types, a query to filter security issues on tags and attributes, and the trigger source.
+    # Only the trigger_source field is required.
+    attr_reader :selectors
+
+    # List of recipients to notify when a notification rule is triggered. Many different target types are supported,
+    # such as email addresses, Slack channels, and PagerDuty services.
+    # The appropriate integrations need to be properly configured to send notifications to the specified targets.
+    attr_reader :targets
+
+    # Time aggregation period (in seconds) is used to aggregate the results of the notification rule evaluation.
+    # Results are aggregated over a selected time frame using a rolling window, which updates with each new evaluation.
+    # Notifications are only sent for new issues discovered during the window.
+    # Time aggregation is only available for vulnerability-based notification rules. When omitted or set to 0, no aggregation
+    # is done.
+    attr_accessor :time_aggregation
+
+    # Version of the notification rule. It is updated when the rule is modified.
+    attr_reader :version
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'created_at' => :'created_at',
+        :'created_by' => :'created_by',
+        :'enabled' => :'enabled',
+        :'modified_at' => :'modified_at',
+        :'modified_by' => :'modified_by',
+        :'name' => :'name',
+        :'selectors' => :'selectors',
+        :'targets' => :'targets',
+        :'time_aggregation' => :'time_aggregation',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'created_at' => :'Integer',
+        :'created_by' => :'RuleUser',
+        :'enabled' => :'Boolean',
+        :'modified_at' => :'Integer',
+        :'modified_by' => :'RuleUser',
+        :'name' => :'String',
+        :'selectors' => :'Selectors',
+        :'targets' => :'Array<String>',
+        :'time_aggregation' => :'Integer',
+        :'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::NotificationRuleAttributes` 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_at']
+      end
+
+      if attributes.key?(:'modified_by')
+        self.modified_by = attributes[:'modified_by']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'selectors')
+        self.selectors = attributes[:'selectors']
+      end
+
+      if attributes.key?(:'targets')
+        if (value = attributes[:'targets']).is_a?(Array)
+          self.targets = value
+        end
+      end
+
+      if attributes.key?(:'time_aggregation')
+        self.time_aggregation = attributes[:'time_aggregation']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      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 @created_at.nil?
+      return false if @created_by.nil?
+      return false if @enabled.nil?
+      return false if @modified_at.nil?
+      return false if @modified_by.nil?
+      return false if @name.nil?
+      return false if @selectors.nil?
+      return false if @targets.nil?
+      return false if @version.nil?
+      true
+    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 enabled [Object] Object to be assigned
+    # @!visibility private
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'invalid value for "enabled", enabled cannot be nil.'
+      end
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param modified_at [Object] Object to be assigned
+    # @!visibility private
+    def modified_at=(modified_at)
+      if modified_at.nil?
+        fail ArgumentError, 'invalid value for "modified_at", modified_at cannot be nil.'
+      end
+      @modified_at = modified_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param modified_by [Object] Object to be assigned
+    # @!visibility private
+    def modified_by=(modified_by)
+      if modified_by.nil?
+        fail ArgumentError, 'invalid value for "modified_by", modified_by cannot be nil.'
+      end
+      @modified_by = modified_by
+    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 selectors [Object] Object to be assigned
+    # @!visibility private
+    def selectors=(selectors)
+      if selectors.nil?
+        fail ArgumentError, 'invalid value for "selectors", selectors cannot be nil.'
+      end
+      @selectors = selectors
+    end
+
+    # Custom attribute writer method with validation
+    # @param targets [Object] Object to be assigned
+    # @!visibility private
+    def targets=(targets)
+      if targets.nil?
+        fail ArgumentError, 'invalid value for "targets", targets cannot be nil.'
+      end
+      @targets = targets
+    end
+
+    # Custom attribute writer method with validation
+    # @param version [Object] Object to be assigned
+    # @!visibility private
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'invalid value for "version", version cannot be nil.'
+      end
+      @version = version
+    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 &&
+          created_at == o.created_at &&
+          created_by == o.created_by &&
+          enabled == o.enabled &&
+          modified_at == o.modified_at &&
+          modified_by == o.modified_by &&
+          name == o.name &&
+          selectors == o.selectors &&
+          targets == o.targets &&
+          time_aggregation == o.time_aggregation &&
+          version == o.version &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [created_at, created_by, enabled, modified_at, modified_by, name, selectors, targets, time_aggregation, version, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/{input_schema_data_attributes_parameters_items.rb → notification_rule_response.rb}

@@ -17,11 +17,15 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The definition of `InputSchemaDataAttributesParametersItems` object.
-  class InputSchemaDataAttributesParametersItems
+  # Response object which includes a notification rule.
+  class NotificationRuleResponse
     include BaseGenericModel
 
-    # The definition of `InputSchemaDataAttributesParametersItemsData` object.
+    # Notification rules allow full control over notifications generated by the various Datadog security products.
+    # They allow users to define the conditions under which a notification should be generated (based on rule severities,
+    # rule types, rule tags, and so on), and the targets to notify.
+    # A notification rule is composed of a rule ID, a rule type, and the rule attributes. All fields are required.
+    #
     attr_accessor :data
 
     attr_accessor :additional_properties
@@ -38,7 +42,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def self.openapi_types
       {
-        :'data' => :'InputSchemaDataAttributesParametersItemsData'
+        :'data' => :'NotificationRule'
       }
     end
 
@@ -47,7 +51,7 @@ module DatadogAPIClient::V2
     # @!visibility private
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::InputSchemaDataAttributesParametersItems` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::NotificationRuleResponse` initialize method"
       end
 
       self.additional_properties = {}

data/lib/datadog_api_client/v2/models/{create_app_request_data_type.rb → notification_rules_type.rb}

@@ -17,10 +17,10 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # The definition of `CreateAppRequestDataType` object.
-  class CreateAppRequestDataType
+  # The rule type associated to notification rules.
+  class NotificationRulesType
     include BaseEnumModel
 
-    APPDEFINITIONS = "appDefinitions".freeze
+    NOTIFICATION_RULES = "notification_rules".freeze
   end
 end

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

@@ -0,0 +1,105 @@
+=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
+  # Body of the notification rule patch request.
+  class PatchNotificationRuleParameters
+    include BaseGenericModel
+
+    # Data of the notification rule patch request: the rule ID, the rule type, and the rule attributes. All fields are required.
+    attr_accessor :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' => :'PatchNotificationRuleParametersData'
+      }
+    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::PatchNotificationRuleParameters` 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')
+        self.data = attributes[:'data']
+      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 &&
+          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/patch_notification_rule_parameters_data.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
+  # Data of the notification rule patch request: the rule ID, the rule type, and the rule attributes. All fields are required.
+  class PatchNotificationRuleParametersData
+    include BaseGenericModel
+
+    # Attributes of the notification rule patch request. It is required to update the version of the rule when patching it.
+    attr_reader :attributes
+
+    # The ID of a notification rule.
+    attr_reader :id
+
+    # The rule type associated to notification rules.
+    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' => :'PatchNotificationRuleParametersDataAttributes',
+        :'id' => :'String',
+        :'type' => :'NotificationRulesType'
+      }
+    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::PatchNotificationRuleParametersData` 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