Class: DependencyTracker::PortfolioMetrics

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/models/portfolio_metrics.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PortfolioMetrics

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 113

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DependencyTracker::PortfolioMetrics` 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::PortfolioMetrics`. 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?(:'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?(:'projects')
    self.projects = attributes[:'projects']
  end

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

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

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

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

  if attributes.key?(:'vulnerable_dependencies')
    self.vulnerable_dependencies = attributes[:'vulnerable_dependencies']
  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

Instance Attribute Details

#components ⇒ Object

Returns the value of attribute components.



33
34
35
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 33

def components
  @components
end

#critical ⇒ Object

Returns the value of attribute critical.



17
18
19
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 17

def critical
  @critical
end

#dependencies ⇒ Object

Returns the value of attribute dependencies.



37
38
39
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 37

def dependencies
  @dependencies
end

#findings_audited ⇒ Object

Returns the value of attribute findings_audited.



45
46
47
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 45

def findings_audited
  @findings_audited
end

#findings_total ⇒ Object

Returns the value of attribute findings_total.



43
44
45
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 43

def findings_total
  @findings_total
end

#findings_unaudited ⇒ Object

Returns the value of attribute findings_unaudited.



47
48
49
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 47

def findings_unaudited
  @findings_unaudited
end

#first_occurrence ⇒ Object

Returns the value of attribute first_occurrence.



51
52
53
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 51

def first_occurrence
  @first_occurrence
end

#high ⇒ Object

Returns the value of attribute high.



19
20
21
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 19

def high
  @high
end

#inherited_risk_score ⇒ Object

Returns the value of attribute inherited_risk_score.



49
50
51
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 49

def inherited_risk_score
  @inherited_risk_score
end

#last_occurrence ⇒ Object

Returns the value of attribute last_occurrence.



53
54
55
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 53

def last_occurrence
  @last_occurrence
end

#low ⇒ Object

Returns the value of attribute low.



23
24
25
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 23

def low
  @low
end

#medium ⇒ Object

Returns the value of attribute medium.



21
22
23
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 21

def medium
  @medium
end

#projects ⇒ Object

Returns the value of attribute projects.



29
30
31
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 29

def projects
  @projects
end

#suppressed ⇒ Object

Returns the value of attribute suppressed.



41
42
43
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 41

def suppressed
  @suppressed
end

#unassigned ⇒ Object

Returns the value of attribute unassigned.



25
26
27
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 25

def unassigned
  @unassigned
end

#vulnerabilities ⇒ Object

Returns the value of attribute vulnerabilities.



27
28
29
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 27

def vulnerabilities
  @vulnerabilities
end

#vulnerable_components ⇒ Object

Returns the value of attribute vulnerable_components.



35
36
37
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 35

def vulnerable_components
  @vulnerable_components
end

#vulnerable_dependencies ⇒ Object

Returns the value of attribute vulnerable_dependencies.



39
40
41
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 39

def vulnerable_dependencies
  @vulnerable_dependencies
end

#vulnerable_projects ⇒ Object

Returns the value of attribute vulnerable_projects.



31
32
33
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 31

def vulnerable_projects
  @vulnerable_projects
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 56

def self.attribute_map
  {
    :'critical' => :'critical',
    :'high' => :'high',
    :'medium' => :'medium',
    :'low' => :'low',
    :'unassigned' => :'unassigned',
    :'vulnerabilities' => :'vulnerabilities',
    :'projects' => :'projects',
    :'vulnerable_projects' => :'vulnerableProjects',
    :'components' => :'components',
    :'vulnerable_components' => :'vulnerableComponents',
    :'dependencies' => :'dependencies',
    :'vulnerable_dependencies' => :'vulnerableDependencies',
    :'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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



267
268
269
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 267

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 106

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 81

def self.openapi_types
  {
    :'critical' => :'Integer',
    :'high' => :'Integer',
    :'medium' => :'Integer',
    :'low' => :'Integer',
    :'unassigned' => :'Integer',
    :'vulnerabilities' => :'Integer',
    :'projects' => :'Integer',
    :'vulnerable_projects' => :'Integer',
    :'components' => :'Integer',
    :'vulnerable_components' => :'Integer',
    :'dependencies' => :'Integer',
    :'vulnerable_dependencies' => :'Integer',
    :'suppressed' => :'Integer',
    :'findings_total' => :'Integer',
    :'findings_audited' => :'Integer',
    :'findings_unaudited' => :'Integer',
    :'inherited_risk_score' => :'Float',
    :'first_occurrence' => :'Integer',
    :'last_occurrence' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      critical == o.critical &&
      high == o.high &&
      medium == o.medium &&
      low == o.low &&
      unassigned == o.unassigned &&
      vulnerabilities == o.vulnerabilities &&
      projects == o.projects &&
      vulnerable_projects == o.vulnerable_projects &&
      components == o.components &&
      vulnerable_components == o.vulnerable_components &&
      dependencies == o.dependencies &&
      vulnerable_dependencies == o.vulnerable_dependencies &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 295

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 364

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 274

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 260

def hash
  [critical, high, medium, low, unassigned, vulnerabilities, projects, vulnerable_projects, components, vulnerable_components, dependencies, vulnerable_dependencies, suppressed, findings_total, findings_audited, findings_unaudited, inherited_risk_score, first_occurrence, last_occurrence].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 205

def list_invalid_properties
  invalid_properties = Array.new
  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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 340

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 346

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



334
335
336
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 334

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



220
221
222
223
224
 
# File 'lib/dependency-tracker-client/models/portfolio_metrics.rb', line 220

def valid?
  return false if @first_occurrence.nil?
  return false if @last_occurrence.nil?
  true
end