class DependencyTracker::ProjectMetrics

Attributes

components[RW]
critical[RW]
findings_audited[RW]
findings_total[RW]
findings_unaudited[RW]
first_occurrence[RW]
high[RW]
inherited_risk_score[RW]
last_occurrence[RW]
low[RW]
medium[RW]
project[RW]
suppressed[RW]
unassigned[RW]
vulnerabilities[RW]
vulnerable_components[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/dependency-tracker-client/models/project_metrics.rb, line 50
def self.attribute_map
  {
    :'project' => :'project',
    :'critical' => :'critical',
    :'high' => :'high',
    :'medium' => :'medium',
    :'low' => :'low',
    :'unassigned' => :'unassigned',
    :'vulnerabilities' => :'vulnerabilities',
    :'vulnerable_components' => :'vulnerableComponents',
    :'components' => :'components',
    :'suppressed' => :'suppressed',
    :'findings_total' => :'findingsTotal',
    :'findings_audited' => :'findingsAudited',
    :'findings_unaudited' => :'findingsUnaudited',
    :'inherited_risk_score' => :'inheritedRiskScore',
    :'first_occurrence' => :'firstOccurrence',
    :'last_occurrence' => :'lastOccurrence'
  }
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/dependency-tracker-client/models/project_metrics.rb, line 245
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/dependency-tracker-client/models/project_metrics.rb, line 101
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DependencyTracker::ProjectMetrics` 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 `DependencyTracker::ProjectMetrics`. 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?(:'project')
    self.project = attributes[:'project']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/dependency-tracker-client/models/project_metrics.rb, line 94
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/dependency-tracker-client/models/project_metrics.rb, line 72
def self.openapi_types
  {
    :'project' => :'Project',
    :'critical' => :'Integer',
    :'high' => :'Integer',
    :'medium' => :'Integer',
    :'low' => :'Integer',
    :'unassigned' => :'Integer',
    :'vulnerabilities' => :'Integer',
    :'vulnerable_components' => :'Integer',
    :'components' => :'Integer',
    :'suppressed' => :'Integer',
    :'findings_total' => :'Integer',
    :'findings_audited' => :'Integer',
    :'findings_unaudited' => :'Integer',
    :'inherited_risk_score' => :'Float',
    :'first_occurrence' => :'Integer',
    :'last_occurrence' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/dependency-tracker-client/models/project_metrics.rb, line 209
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      project == o.project &&
      critical == o.critical &&
      high == o.high &&
      medium == o.medium &&
      low == o.low &&
      unassigned == o.unassigned &&
      vulnerabilities == o.vulnerabilities &&
      vulnerable_components == o.vulnerable_components &&
      components == o.components &&
      suppressed == o.suppressed &&
      findings_total == o.findings_total &&
      findings_audited == o.findings_audited &&
      findings_unaudited == o.findings_unaudited &&
      inherited_risk_score == o.inherited_risk_score &&
      first_occurrence == o.first_occurrence &&
      last_occurrence == o.last_occurrence
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/dependency-tracker-client/models/project_metrics.rb, line 273
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
    DependencyTracker.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/dependency-tracker-client/models/project_metrics.rb, line 342
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/dependency-tracker-client/models/project_metrics.rb, line 252
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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/dependency-tracker-client/models/project_metrics.rb, line 232
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/dependency-tracker-client/models/project_metrics.rb, line 238
def hash
  [project, critical, high, medium, low, unassigned, vulnerabilities, vulnerable_components, components, suppressed, findings_total, findings_audited, findings_unaudited, inherited_risk_score, first_occurrence, last_occurrence].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/dependency-tracker-client/models/project_metrics.rb, line 181
def list_invalid_properties
  invalid_properties = Array.new
  if @project.nil?
    invalid_properties.push('invalid value for "project", project cannot be nil.')
  end

  if @first_occurrence.nil?
    invalid_properties.push('invalid value for "first_occurrence", first_occurrence cannot be nil.')
  end

  if @last_occurrence.nil?
    invalid_properties.push('invalid value for "last_occurrence", last_occurrence cannot be nil.')
  end

  invalid_properties
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/dependency-tracker-client/models/project_metrics.rb, line 318
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/dependency-tracker-client/models/project_metrics.rb, line 324
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/dependency-tracker-client/models/project_metrics.rb, line 312
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/dependency-tracker-client/models/project_metrics.rb, line 200
def valid?
  return false if @project.nil?
  return false if @first_occurrence.nil?
  return false if @last_occurrence.nil?
  true
end