Class: CloudsmithApi::VulnerabilityScanResults

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/models/vulnerability_scan_results.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VulnerabilityScanResults

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 88

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'has_vulnerabilities')
    self.has_vulnerabilities = attributes[:'has_vulnerabilities']
  end

  if attributes.has_key?(:'identifier')
    self.identifier = attributes[:'identifier']
  end

  if attributes.has_key?(:'max_severity')
    self.max_severity = attributes[:'max_severity']
  else
    self.max_severity = 'Unknown'
  end

  if attributes.has_key?(:'num_vulnerabilities')
    self.num_vulnerabilities = attributes[:'num_vulnerabilities']
  end

  if attributes.has_key?(:'package')
    self.package = attributes[:'package']
  end

  if attributes.has_key?(:'scan')
    self.scan = attributes[:'scan']
  end

  if attributes.has_key?(:'scan_id')
    self.scan_id = attributes[:'scan_id']
  end
end

Instance Attribute Details

#created_atObject

The time this scan result was stored.



18
19
20
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 18

def created_at
  @created_at
end

#has_vulnerabilitiesObject

Do the results contain any known vulnerabilities?



21
22
23
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 21

def has_vulnerabilities
  @has_vulnerabilities
end

#identifierObject

Returns the value of attribute identifier.



23
24
25
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 23

def identifier
  @identifier
end

#max_severityObject

Returns the value of attribute max_severity.



25
26
27
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 25

def max_severity
  @max_severity
end

#num_vulnerabilitiesObject

Returns the value of attribute num_vulnerabilities.



27
28
29
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 27

def num_vulnerabilities
  @num_vulnerabilities
end

#packageObject

Returns the value of attribute package.



29
30
31
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 29

def package
  @package
end

#scanObject

Returns the value of attribute scan.



31
32
33
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 31

def scan
  @scan
end

#scan_idObject

Deprecated (23-05-15): Please use ‘identifier’ instead. Previously: A monotonically increasing number that identified a scan within a repository.



34
35
36
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 34

def scan_id
  @scan_id
end

Class Method Details

.attribute_mapObject

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



59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 59

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'has_vulnerabilities' => :'has_vulnerabilities',
    :'identifier' => :'identifier',
    :'max_severity' => :'max_severity',
    :'num_vulnerabilities' => :'num_vulnerabilities',
    :'package' => :'package',
    :'scan' => :'scan',
    :'scan_id' => :'scan_id'
  }
end

.swagger_typesObject

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 73

def self.swagger_types
  {
    :'created_at' => :'DateTime',
    :'has_vulnerabilities' => :'BOOLEAN',
    :'identifier' => :'String',
    :'max_severity' => :'String',
    :'num_vulnerabilities' => :'Integer',
    :'package' => :'PackageVulnerability',
    :'scan' => :'VulnerabilityScan',
    :'scan_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      has_vulnerabilities == o.has_vulnerabilities &&
      identifier == o.identifier &&
      max_severity == o.max_severity &&
      num_vulnerabilities == o.num_vulnerabilities &&
      package == o.package &&
      scan == o.scan &&
      scan_id == o.scan_id
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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 225

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
    temp_model = CloudsmithApi.const_get(type).new
    temp_model.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



291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 291

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 204

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


191
192
193
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 191

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



197
198
199
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 197

def hash
  [created_at, has_vulnerabilities, identifier, max_severity, num_vulnerabilities, package, scan, scan_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  if @identifier.nil?
    invalid_properties.push('invalid value for "identifier", identifier cannot be nil.')
  end

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



271
272
273
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 271

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



277
278
279
280
281
282
283
284
285
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 277

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



265
266
267
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 265

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



154
155
156
157
158
159
160
161
162
# File 'lib/cloudsmith-api/models/vulnerability_scan_results.rb', line 154

def valid?
  return false if @identifier.nil?
  max_severity_validator = EnumAttributeValidator.new('String', ['Unknown', 'Low', 'Medium', 'High', 'Critical'])
  return false unless max_severity_validator.valid?(@max_severity)
  return false if @package.nil?
  return false if @scan.nil?
  return false if @scan_id.nil?
  true
end