class EmassClient::StaticCodeApplication

Attributes

clear_findings[RW]
Optional

When used by itself, can clear out all application findings for a single application/version pairing.

code_check_name[RW]
Required

Name of the software vulnerability or weakness.

count[RW]
Optional

Number of instances observed for a specified finding.

cwe_id[RW]
Required

The Common Weakness Enumerator (CWE) identifier.

raw_severity[RW]
Optional

Scan vulnerability ratting

scan_date[RW]
Required

The date of the scan. Unix date format.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/emass_client/models/static_code_application.rb, line 57
def self.attribute_map
  {
    :'raw_severity' => :'rawSeverity',
    :'code_check_name' => :'codeCheckName',
    :'count' => :'count',
    :'scan_date' => :'scanDate',
    :'cwe_id' => :'cweId',
    :'clear_findings' => :'clearFindings'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/emass_client/models/static_code_application.rb, line 191
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/emass_client/models/static_code_application.rb, line 88
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::StaticCodeApplication` 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 `EmassClient::StaticCodeApplication`. 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?(:'raw_severity')
    self.raw_severity = attributes[:'raw_severity']
  end

  if attributes.key?(:'code_check_name')
    self.code_check_name = attributes[:'code_check_name']
  end

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  end

  if attributes.key?(:'scan_date')
    self.scan_date = attributes[:'scan_date']
  end

  if attributes.key?(:'cwe_id')
    self.cwe_id = attributes[:'cwe_id']
  end

  if attributes.key?(:'clear_findings')
    self.clear_findings = attributes[:'clear_findings']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/emass_client/models/static_code_application.rb, line 81
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/emass_client/models/static_code_application.rb, line 69
def self.openapi_types
  {
    :'raw_severity' => :'Object',
    :'code_check_name' => :'Object',
    :'count' => :'Object',
    :'scan_date' => :'Object',
    :'cwe_id' => :'Object',
    :'clear_findings' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/emass_client/models/static_code_application.rb, line 165
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      raw_severity == o.raw_severity &&
      code_check_name == o.code_check_name &&
      count == o.count &&
      scan_date == o.scan_date &&
      cwe_id == o.cwe_id &&
      clear_findings == o.clear_findings
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/emass_client/models/static_code_application.rb, line 221
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    EmassClient.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/emass_client/models/static_code_application.rb, line 290
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/emass_client/models/static_code_application.rb, line 198
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
code_check_name=(code_check_name) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] code_check_name Object to be assigned

# File lib/emass_client/models/static_code_application.rb, line 155
def code_check_name=(code_check_name)
  validator = EnumAttributeValidator.new('Object', ['Hidden Field', 'Redundant Check', 'Invalid Field', 'Vulnerable Field'])
  unless validator.valid?(code_check_name)
    fail ArgumentError, "invalid value for \"code_check_name\", must be one of #{validator.allowable_values}."
  end
  @code_check_name = code_check_name
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/emass_client/models/static_code_application.rb, line 178
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/emass_client/models/static_code_application.rb, line 184
def hash
  [raw_severity, code_check_name, count, scan_date, cwe_id, clear_findings].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/emass_client/models/static_code_application.rb, line 128
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
raw_severity=(raw_severity) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] raw_severity Object to be assigned

# File lib/emass_client/models/static_code_application.rb, line 145
def raw_severity=(raw_severity)
  validator = EnumAttributeValidator.new('Object', ['Low', 'Medium', 'Moderate', 'High', 'Critical'])
  unless validator.valid?(raw_severity)
    fail ArgumentError, "invalid value for \"raw_severity\", must be one of #{validator.allowable_values}."
  end
  @raw_severity = raw_severity
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/emass_client/models/static_code_application.rb, line 266
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/emass_client/models/static_code_application.rb, line 272
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/emass_client/models/static_code_application.rb, line 260
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/emass_client/models/static_code_application.rb, line 135
def valid?
  raw_severity_validator = EnumAttributeValidator.new('Object', ['Low', 'Medium', 'Moderate', 'High', 'Critical'])
  return false unless raw_severity_validator.valid?(@raw_severity)
  code_check_name_validator = EnumAttributeValidator.new('Object', ['Hidden Field', 'Redundant Check', 'Invalid Field', 'Vulnerable Field'])
  return false unless code_check_name_validator.valid?(@code_check_name)
  true
end