Class: Falcon::DomainBaseAPIVulnerabilityV2

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainBaseAPIVulnerabilityV2

Initializes the object



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 140

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

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

  if attributes.key?(:'apps')
    if (value = attributes[:'apps']).is_a?(Array)
      self.apps = value
    end
  end

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

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

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

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

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

  if attributes.key?(:'data_providers')
    if (value = attributes[:'data_providers']).is_a?(Array)
      self.data_providers = value
    end
  end

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

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

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

  if attributes.key?(:'services')
    if (value = attributes[:'services']).is_a?(Array)
      self.services = value
    end
  end

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

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

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

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

Instance Attribute Details

#aidObject

Asset ID for which the vulnerability has been detected. For managed assets it can correspond to the sensor ID, for unmanaged assets can be a stand alone ID



36
37
38
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 36

def aid
  @aid
end

#appObject

Returns the value of attribute app.



38
39
40
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 38

def app
  @app
end

#appsObject

Provide details related to the products for which a the vulnerability has been detected



41
42
43
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 41

def apps
  @apps
end

#cidObject

Contains the customer identifier associated with the asset for which the vulnerability has been detected



44
45
46
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 44

def cid
  @cid
end

#closed_timestampObject

A timestamp corresponding to the point in time when the vulnerability has no longer been detected (eg: it got fixed)



47
48
49
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 47

def closed_timestamp
  @closed_timestamp
end

#confidenceObject

Represents the confidence level of a vulnerability



50
51
52
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 50

def confidence
  @confidence
end

#created_timestampObject

A timestamp corresponding to the point in time when the vulnerability has been created (detected) in our system



53
54
55
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 53

def created_timestamp
  @created_timestamp
end

#cveObject

Returns the value of attribute cve.



55
56
57
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 55

def cve
  @cve
end

#data_providersObject

Contains information about the vulnerability data providers of this entity



58
59
60
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 58

def data_providers
  @data_providers
end

#host_infoObject

Returns the value of attribute host_info.



60
61
62
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 60

def host_info
  @host_info
end

#idObject

Vulnerability unique ID



63
64
65
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 63

def id
  @id
end

#remediationObject

Returns the value of attribute remediation.



65
66
67
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 65

def remediation
  @remediation
end

#servicesObject

Contains details about the vulnerable services



68
69
70
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 68

def services
  @services
end

#statusObject

Current status of a vulnerability (open, closed, reopen)



71
72
73
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 71

def status
  @status
end

#suppression_infoObject

Returns the value of attribute suppression_info.



73
74
75
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 73

def suppression_info
  @suppression_info
end

#updated_timestampObject

A timestamp corresponding to the point in time when a vulnerability’s information or status have been updated



76
77
78
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 76

def updated_timestamp
  @updated_timestamp
end

#vulnerability_idObject

Dynamic label that contains the CVE ID if applicable, otherwise the vulnerability metadata ID or label from the provider



79
80
81
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 79

def vulnerability_id
  @vulnerability_id
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



105
106
107
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 105

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 82

def self.attribute_map
  {
    :'aid' => :'aid',
    :'app' => :'app',
    :'apps' => :'apps',
    :'cid' => :'cid',
    :'closed_timestamp' => :'closed_timestamp',
    :'confidence' => :'confidence',
    :'created_timestamp' => :'created_timestamp',
    :'cve' => :'cve',
    :'data_providers' => :'data_providers',
    :'host_info' => :'host_info',
    :'id' => :'id',
    :'remediation' => :'remediation',
    :'services' => :'services',
    :'status' => :'status',
    :'suppression_info' => :'suppression_info',
    :'updated_timestamp' => :'updated_timestamp',
    :'vulnerability_id' => :'vulnerability_id'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



310
311
312
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 310

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

.openapi_nullableObject

List of attributes with nullable: true



133
134
135
136
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 133

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

.openapi_typesObject

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 110

def self.openapi_types
  {
    :'aid' => :'String',
    :'app' => :'DomainAPIVulnerabilityAppV2',
    :'apps' => :'Array<DomainAPIVulnerabilityExtendedAppV2>',
    :'cid' => :'String',
    :'closed_timestamp' => :'String',
    :'confidence' => :'String',
    :'created_timestamp' => :'String',
    :'cve' => :'DomainAPIVulnerabilityCVEDetailsFacetV2',
    :'data_providers' => :'Array<DomainAPIVulnerabilityDataProviderV1>',
    :'host_info' => :'DomainAPIVulnerabilityHostFacetV2',
    :'id' => :'String',
    :'remediation' => :'DomainAPIVulnerabilityRemediationFacetV2',
    :'services' => :'Array<DomainAPIVulnerabilityServiceV2>',
    :'status' => :'String',
    :'suppression_info' => :'DomainAPIVulnerabilitySuppressionInfoV2',
    :'updated_timestamp' => :'String',
    :'vulnerability_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 273

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aid == o.aid &&
      app == o.app &&
      apps == o.apps &&
      cid == o.cid &&
      closed_timestamp == o.closed_timestamp &&
      confidence == o.confidence &&
      created_timestamp == o.created_timestamp &&
      cve == o.cve &&
      data_providers == o.data_providers &&
      host_info == o.host_info &&
      id == o.id &&
      remediation == o.remediation &&
      services == o.services &&
      status == o.status &&
      suppression_info == o.suppression_info &&
      updated_timestamp == o.updated_timestamp &&
      vulnerability_id == o.vulnerability_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 341

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

#_to_hash(value) ⇒ Hash

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



412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 412

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 317

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


297
298
299
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 297

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



303
304
305
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 303

def hash
  [aid, app, apps, cid, closed_timestamp, confidence, created_timestamp, cve, data_providers, host_info, id, remediation, services, status, suppression_info, updated_timestamp, vulnerability_id].hash
end

#list_invalid_propertiesObject

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



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
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 230

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



388
389
390
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 388

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



394
395
396
397
398
399
400
401
402
403
404
405
406
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 394

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_sString

Returns the string representation of the object



382
383
384
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 382

def to_s
  to_hash.to_s
end

#valid?Boolean

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



261
262
263
264
265
266
267
268
269
# File 'lib/crimson-falcon/models/domain_base_api_vulnerability_v2.rb', line 261

def valid?
  return false if @aid.nil?
  return false if @cid.nil?
  return false if @created_timestamp.nil?
  return false if @id.nil?
  return false if @status.nil?
  return false if @updated_timestamp.nil?
  true
end