datadog_api_client 2.55.0 → 2.56.0

data/lib/datadog_api_client/v2/models/mute_rule_action.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
+  # The action to take when the mute rule matches a finding.
+  class MuteRuleAction
+    include BaseGenericModel
+
+    # The Unix timestamp in milliseconds at which the mute expires. If omitted, the mute does not expire.
+    attr_accessor :expire_at
+
+    # The reason for muting a security finding.
+    attr_reader :reason
+
+    # An optional description providing more context for the mute reason.
+    attr_reader :reason_description
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'expire_at' => :'expire_at',
+        :'reason' => :'reason',
+        :'reason_description' => :'reason_description'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'expire_at' => :'Integer',
+        :'reason' => :'MuteReason',
+        :'reason_description' => :'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::MuteRuleAction` 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?(:'expire_at')
+        self.expire_at = attributes[:'expire_at']
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.key?(:'reason_description')
+        self.reason_description = attributes[:'reason_description']
+      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 @reason.nil?
+      return false if !@reason_description.nil? && @reason_description.to_s.length > 20000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param reason [Object] Object to be assigned
+    # @!visibility private
+    def reason=(reason)
+      if reason.nil?
+        fail ArgumentError, 'invalid value for "reason", reason cannot be nil.'
+      end
+      @reason = reason
+    end
+
+    # Custom attribute writer method with validation
+    # @param reason_description [Object] Object to be assigned
+    # @!visibility private
+    def reason_description=(reason_description)
+      if !reason_description.nil? && reason_description.to_s.length > 20000
+        fail ArgumentError, 'invalid value for "reason_description", the character length must be smaller than or equal to 20000.'
+      end
+      @reason_description = reason_description
+    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 &&
+          expire_at == o.expire_at &&
+          reason == o.reason &&
+          reason_description == o.reason_description &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [expire_at, reason, reason_description, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+=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 creating or updating a mute rule.
+  class MuteRuleAttributesCreate
+    include BaseGenericModel
+
+    # The action to take when the mute rule matches a finding.
+    attr_reader :action
+
+    # Whether the mute rule is enabled.
+    attr_accessor :enabled
+
+    # The name of the mute rule.
+    attr_reader :name
+
+    # Defines the scope of findings to which the automation rule applies.
+    attr_reader :rule
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'enabled' => :'enabled',
+        :'name' => :'name',
+        :'rule' => :'rule'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'action' => :'MuteRuleAction',
+        :'enabled' => :'Boolean',
+        :'name' => :'String',
+        :'rule' => :'AutomationRuleScope'
+      }
+    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::MuteRuleAttributesCreate` 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?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'rule')
+        self.rule = attributes[:'rule']
+      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 @action.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length > 255
+      return false if @name.to_s.length < 1
+      return false if @rule.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param action [Object] Object to be assigned
+    # @!visibility private
+    def action=(action)
+      if action.nil?
+        fail ArgumentError, 'invalid value for "action", action cannot be nil.'
+      end
+      @action = action
+    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
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param rule [Object] Object to be assigned
+    # @!visibility private
+    def rule=(rule)
+      if rule.nil?
+        fail ArgumentError, 'invalid value for "rule", rule cannot be nil.'
+      end
+      @rule = rule
+    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 &&
+          action == o.action &&
+          enabled == o.enabled &&
+          name == o.name &&
+          rule == o.rule &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [action, enabled, name, rule, additional_properties].hash
+    end
+  end
+end

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

@@ -0,0 +1,278 @@
+=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 mute rule returned by the API.
+  class MuteRuleAttributesResponse
+    include BaseGenericModel
+
+    # The action to take when the mute rule matches a finding.
+    attr_reader :action
+
+    # The Unix timestamp in milliseconds when the rule was created.
+    attr_reader :created_at
+
+    # The user or Datadog system who created the rule.
+    attr_reader :created_by
+
+    # Whether the mute rule is enabled.
+    attr_reader :enabled
+
+    # The Unix timestamp in milliseconds when the rule was last modified.
+    attr_reader :modified_at
+
+    # The user or Datadog system who last modified the rule.
+    attr_reader :modified_by
+
+    # The name of the mute rule.
+    attr_reader :name
+
+    # Defines the scope of findings to which the automation rule applies.
+    attr_reader :rule
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'created_at' => :'created_at',
+        :'created_by' => :'created_by',
+        :'enabled' => :'enabled',
+        :'modified_at' => :'modified_at',
+        :'modified_by' => :'modified_by',
+        :'name' => :'name',
+        :'rule' => :'rule'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'action' => :'MuteRuleAction',
+        :'created_at' => :'Integer',
+        :'created_by' => :'AutomationRuleCreatedBy',
+        :'enabled' => :'Boolean',
+        :'modified_at' => :'Integer',
+        :'modified_by' => :'AutomationRuleModifiedBy',
+        :'name' => :'String',
+        :'rule' => :'AutomationRuleScope'
+      }
+    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::MuteRuleAttributesResponse` 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?(:'action')
+        self.action = attributes[:'action']
+      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?(:'rule')
+        self.rule = attributes[:'rule']
+      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 @action.nil?
+      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 @name.to_s.length > 255
+      return false if @name.to_s.length < 1
+      return false if @rule.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param action [Object] Object to be assigned
+    # @!visibility private
+    def action=(action)
+      if action.nil?
+        fail ArgumentError, 'invalid value for "action", action cannot be nil.'
+      end
+      @action = action
+    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
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param rule [Object] Object to be assigned
+    # @!visibility private
+    def rule=(rule)
+      if rule.nil?
+        fail ArgumentError, 'invalid value for "rule", rule cannot be nil.'
+      end
+      @rule = rule
+    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 &&
+          action == o.action &&
+          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 &&
+          rule == o.rule &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [action, created_at, created_by, enabled, modified_at, modified_by, name, rule, additional_properties].hash
+    end
+  end
+end