crimson-falcon 1.0.1 → 1.1.0

data/lib/crimson-falcon/models/domain_ddos_attack_source.rb

@@ -0,0 +1,423 @@
+=begin
+Crimson Falcon - Ruby Client SDK
+
+Code auto-generated by OpenAPI Generator; DO NOT EDIT.
+
+MIT License
+
+Copyright (c) 2023 Crowdstrike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+=end
+
+require 'date'
+require 'time'
+
+module Falcon
+  class DomainDDOSAttackSource
+    # The type of attack. One of `Amplification`, `Botnet`, `Other`
+    attr_accessor :attack_type
+
+    # The confidence level. One of `Low`, `Medium`, `High`
+    attr_accessor :confidence
+
+    # The duration of the attack in seconds
+    attr_accessor :duration
+
+    # The hash over target and date
+    attr_accessor :key
+
+    # The network protocol used. One of `TCP`, `UDP`, `ICMP`, `Other`
+    attr_accessor :network_protocol
+
+    # The protocols used in the attack
+    attr_accessor :protocols
+
+    # The number of requests against the target
+    attr_accessor :requests
+
+    # The ISO-8601 date for the attack start time
+    attr_accessor :start_time
+
+    # The target's IPv4/6 address or hostname
+    attr_accessor :target
+
+    attr_accessor :target_details
+
+    # The target's domain
+    attr_accessor :target_domain
+
+    # The target's IPv4/6 address
+    attr_accessor :target_ip
+
+    # List of ports where the attack took place
+    attr_accessor :target_ports
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attack_type' => :'attack_type',
+        :'confidence' => :'confidence',
+        :'duration' => :'duration',
+        :'key' => :'key',
+        :'network_protocol' => :'network_protocol',
+        :'protocols' => :'protocols',
+        :'requests' => :'requests',
+        :'start_time' => :'start_time',
+        :'target' => :'target',
+        :'target_details' => :'target_details',
+        :'target_domain' => :'target_domain',
+        :'target_ip' => :'target_ip',
+        :'target_ports' => :'target_ports'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attack_type' => :'String',
+        :'confidence' => :'String',
+        :'duration' => :'Integer',
+        :'key' => :'String',
+        :'network_protocol' => :'String',
+        :'protocols' => :'Array<String>',
+        :'requests' => :'Integer',
+        :'start_time' => :'String',
+        :'target' => :'String',
+        :'target_details' => :'DomainDDOSTargetDetails',
+        :'target_domain' => :'String',
+        :'target_ip' => :'String',
+        :'target_ports' => :'Array<Integer>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::DomainDDOSAttackSource` initialize method"
+      end
+
+      # 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Falcon::DomainDDOSAttackSource`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'attack_type')
+        self.attack_type = attributes[:'attack_type']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'duration')
+        self.duration = attributes[:'duration']
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      end
+
+      if attributes.key?(:'network_protocol')
+        self.network_protocol = attributes[:'network_protocol']
+      end
+
+      if attributes.key?(:'protocols')
+        if (value = attributes[:'protocols']).is_a?(Array)
+          self.protocols = value
+        end
+      end
+
+      if attributes.key?(:'requests')
+        self.requests = attributes[:'requests']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      end
+
+      if attributes.key?(:'target_details')
+        self.target_details = attributes[:'target_details']
+      end
+
+      if attributes.key?(:'target_domain')
+        self.target_domain = attributes[:'target_domain']
+      end
+
+      if attributes.key?(:'target_ip')
+        self.target_ip = attributes[:'target_ip']
+      end
+
+      if attributes.key?(:'target_ports')
+        if (value = attributes[:'target_ports']).is_a?(Array)
+          self.target_ports = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @attack_type.nil?
+        invalid_properties.push('invalid value for "attack_type", attack_type cannot be nil.')
+      end
+
+      if @confidence.nil?
+        invalid_properties.push('invalid value for "confidence", confidence cannot be nil.')
+      end
+
+      if @duration.nil?
+        invalid_properties.push('invalid value for "duration", duration cannot be nil.')
+      end
+
+      if @key.nil?
+        invalid_properties.push('invalid value for "key", key cannot be nil.')
+      end
+
+      if @network_protocol.nil?
+        invalid_properties.push('invalid value for "network_protocol", network_protocol cannot be nil.')
+      end
+
+      if @protocols.nil?
+        invalid_properties.push('invalid value for "protocols", protocols cannot be nil.')
+      end
+
+      if @requests.nil?
+        invalid_properties.push('invalid value for "requests", requests cannot be nil.')
+      end
+
+      if @start_time.nil?
+        invalid_properties.push('invalid value for "start_time", start_time cannot be nil.')
+      end
+
+      if @target.nil?
+        invalid_properties.push('invalid value for "target", target cannot be nil.')
+      end
+
+      if @target_details.nil?
+        invalid_properties.push('invalid value for "target_details", target_details cannot be nil.')
+      end
+
+      if @target_domain.nil?
+        invalid_properties.push('invalid value for "target_domain", target_domain cannot be nil.')
+      end
+
+      if @target_ip.nil?
+        invalid_properties.push('invalid value for "target_ip", target_ip cannot be nil.')
+      end
+
+      if @target_ports.nil?
+        invalid_properties.push('invalid value for "target_ports", target_ports cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @attack_type.nil?
+      return false if @confidence.nil?
+      return false if @duration.nil?
+      return false if @key.nil?
+      return false if @network_protocol.nil?
+      return false if @protocols.nil?
+      return false if @requests.nil?
+      return false if @start_time.nil?
+      return false if @target.nil?
+      return false if @target_details.nil?
+      return false if @target_domain.nil?
+      return false if @target_ip.nil?
+      return false if @target_ports.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          attack_type == o.attack_type &&
+          confidence == o.confidence &&
+          duration == o.duration &&
+          key == o.key &&
+          network_protocol == o.network_protocol &&
+          protocols == o.protocols &&
+          requests == o.requests &&
+          start_time == o.start_time &&
+          target == o.target &&
+          target_details == o.target_details &&
+          target_domain == o.target_domain &&
+          target_ip == o.target_ip &&
+          target_ports == o.target_ports
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [attack_type, confidence, duration, key, network_protocol, protocols, requests, start_time, target, target_details, target_domain, target_ip, target_ports].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Falcon.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end