Class: Falcon::DomainIncident

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainIncident

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/crimson-falcon/models/domain_incident.rb', line 172

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_endObject

Returns the value of attribute _end.



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

def _end
  @_end
end

#assigned_toObject

Returns the value of attribute assigned_to.



35
36
37
# File 'lib/crimson-falcon/models/domain_incident.rb', line 35

def assigned_to
  @assigned_to
end

#assigned_to_nameObject

Returns the value of attribute assigned_to_name.



37
38
39
# File 'lib/crimson-falcon/models/domain_incident.rb', line 37

def assigned_to_name
  @assigned_to_name
end

#cidObject

Returns the value of attribute cid.



39
40
41
# File 'lib/crimson-falcon/models/domain_incident.rb', line 39

def cid
  @cid
end

#createdObject

Returns the value of attribute created.



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

def created
  @created
end

#descriptionObject

Returns the value of attribute description.



43
44
45
# File 'lib/crimson-falcon/models/domain_incident.rb', line 43

def description
  @description
end

#email_stateObject

Returns the value of attribute email_state.



45
46
47
# File 'lib/crimson-falcon/models/domain_incident.rb', line 45

def email_state
  @email_state
end

#events_histogramObject

Returns the value of attribute events_histogram.



49
50
51
# File 'lib/crimson-falcon/models/domain_incident.rb', line 49

def events_histogram
  @events_histogram
end

#fine_scoreObject

Returns the value of attribute fine_score.



51
52
53
# File 'lib/crimson-falcon/models/domain_incident.rb', line 51

def fine_score
  @fine_score
end

#host_idsObject

Returns the value of attribute host_ids.



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

def host_ids
  @host_ids
end

#hostsObject

Returns the value of attribute hosts.



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

def hosts
  @hosts
end

#incident_idObject

Returns the value of attribute incident_id.



57
58
59
# File 'lib/crimson-falcon/models/domain_incident.rb', line 57

def incident_id
  @incident_id
end

#incident_typeObject

Returns the value of attribute incident_type.



59
60
61
# File 'lib/crimson-falcon/models/domain_incident.rb', line 59

def incident_type
  @incident_type
end

#lm_host_idsObject

Returns the value of attribute lm_host_ids.



61
62
63
# File 'lib/crimson-falcon/models/domain_incident.rb', line 61

def lm_host_ids
  @lm_host_ids
end

#lm_hosts_cappedObject

Returns the value of attribute lm_hosts_capped.



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

def lm_hosts_capped
  @lm_hosts_capped
end

#lm_typesObject

Returns the value of attribute lm_types.



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

def lm_types
  @lm_types
end

#lmra_host_idsObject

Returns the value of attribute lmra_host_ids.



67
68
69
# File 'lib/crimson-falcon/models/domain_incident.rb', line 67

def lmra_host_ids
  @lmra_host_ids
end

#lmra_hosts_cappedObject

Returns the value of attribute lmra_hosts_capped.



69
70
71
# File 'lib/crimson-falcon/models/domain_incident.rb', line 69

def lmra_hosts_capped
  @lmra_hosts_capped
end

#modified_timestampObject

Returns the value of attribute modified_timestamp.



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

def modified_timestamp
  @modified_timestamp
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#objectivesObject

Returns the value of attribute objectives.



75
76
77
# File 'lib/crimson-falcon/models/domain_incident.rb', line 75

def objectives
  @objectives
end

#startObject

Returns the value of attribute start.



77
78
79
# File 'lib/crimson-falcon/models/domain_incident.rb', line 77

def start
  @start
end

#stateObject

Returns the value of attribute state.



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

def state
  @state
end

#statusObject

Returns the value of attribute status.



81
82
83
# File 'lib/crimson-falcon/models/domain_incident.rb', line 81

def status
  @status
end

#tacticsObject

Returns the value of attribute tactics.



83
84
85
# File 'lib/crimson-falcon/models/domain_incident.rb', line 83

def tactics
  @tactics
end

#tagsObject

Returns the value of attribute tags.



85
86
87
# File 'lib/crimson-falcon/models/domain_incident.rb', line 85

def tags
  @tags
end

#techniquesObject

Returns the value of attribute techniques.



87
88
89
# File 'lib/crimson-falcon/models/domain_incident.rb', line 87

def techniques
  @techniques
end

#usersObject

Returns the value of attribute users.



89
90
91
# File 'lib/crimson-falcon/models/domain_incident.rb', line 89

def users
  @users
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



126
127
128
# File 'lib/crimson-falcon/models/domain_incident.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'assigned_to' => :'assigned_to',
    :'assigned_to_name' => :'assigned_to_name',
    :'cid' => :'cid',
    :'created' => :'created',
    :'description' => :'description',
    :'email_state' => :'email_state',
    :'_end' => :'end',
    :'events_histogram' => :'events_histogram',
    :'fine_score' => :'fine_score',
    :'host_ids' => :'host_ids',
    :'hosts' => :'hosts',
    :'incident_id' => :'incident_id',
    :'incident_type' => :'incident_type',
    :'lm_host_ids' => :'lm_host_ids',
    :'lm_hosts_capped' => :'lm_hosts_capped',
    :'lm_types' => :'lm_types',
    :'lmra_host_ids' => :'lmra_host_ids',
    :'lmra_hosts_capped' => :'lmra_hosts_capped',
    :'modified_timestamp' => :'modified_timestamp',
    :'name' => :'name',
    :'objectives' => :'objectives',
    :'start' => :'start',
    :'state' => :'state',
    :'status' => :'status',
    :'tactics' => :'tactics',
    :'tags' => :'tags',
    :'techniques' => :'techniques',
    :'users' => :'users'
  }
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



421
422
423
# File 'lib/crimson-falcon/models/domain_incident.rb', line 421

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

.openapi_nullableObject

List of attributes with nullable: true



165
166
167
168
# File 'lib/crimson-falcon/models/domain_incident.rb', line 165

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'assigned_to' => :'String',
    :'assigned_to_name' => :'String',
    :'cid' => :'String',
    :'created' => :'Time',
    :'description' => :'String',
    :'email_state' => :'String',
    :'_end' => :'Time',
    :'events_histogram' => :'Array<DomainEventHistogram>',
    :'fine_score' => :'Integer',
    :'host_ids' => :'Array<String>',
    :'hosts' => :'Array<DetectsDeviceDetailIndexed>',
    :'incident_id' => :'String',
    :'incident_type' => :'Integer',
    :'lm_host_ids' => :'Array<String>',
    :'lm_hosts_capped' => :'Boolean',
    :'lm_types' => :'Integer',
    :'lmra_host_ids' => :'Array<String>',
    :'lmra_hosts_capped' => :'Boolean',
    :'modified_timestamp' => :'Time',
    :'name' => :'String',
    :'objectives' => :'Array<String>',
    :'start' => :'Time',
    :'state' => :'String',
    :'status' => :'Integer',
    :'tactics' => :'Array<String>',
    :'tags' => :'Array<String>',
    :'techniques' => :'Array<String>',
    :'users' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
# File 'lib/crimson-falcon/models/domain_incident.rb', line 373

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assigned_to == o.assigned_to &&
      assigned_to_name == o.assigned_to_name &&
      cid == o.cid &&
      created == o.created &&
      description == o.description &&
      email_state == o.email_state &&
      _end == o._end &&
      events_histogram == o.events_histogram &&
      fine_score == o.fine_score &&
      host_ids == o.host_ids &&
      hosts == o.hosts &&
      incident_id == o.incident_id &&
      incident_type == o.incident_type &&
      lm_host_ids == o.lm_host_ids &&
      lm_hosts_capped == o.lm_hosts_capped &&
      lm_types == o.lm_types &&
      lmra_host_ids == o.lmra_host_ids &&
      lmra_hosts_capped == o.lmra_hosts_capped &&
      modified_timestamp == o.modified_timestamp &&
      name == o.name &&
      objectives == o.objectives &&
      start == o.start &&
      state == o.state &&
      status == o.status &&
      tactics == o.tactics &&
      tags == o.tags &&
      techniques == o.techniques &&
      users == o.users
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



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# File 'lib/crimson-falcon/models/domain_incident.rb', line 452

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'lib/crimson-falcon/models/domain_incident.rb', line 523

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



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
# File 'lib/crimson-falcon/models/domain_incident.rb', line 428

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


408
409
410
# File 'lib/crimson-falcon/models/domain_incident.rb', line 408

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



414
415
416
# File 'lib/crimson-falcon/models/domain_incident.rb', line 414

def hash
  [assigned_to, assigned_to_name, cid, created, description, email_state, _end, events_histogram, fine_score, host_ids, hosts, incident_id, incident_type, lm_host_ids, lm_hosts_capped, lm_types, lmra_host_ids, lmra_hosts_capped, modified_timestamp, name, objectives, start, state, status, tactics, tags, techniques, users].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/crimson-falcon/models/domain_incident.rb', line 320

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

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

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

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

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

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

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

  if @state.nil?
    invalid_properties.push('invalid value for "state", state 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



499
500
501
# File 'lib/crimson-falcon/models/domain_incident.rb', line 499

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



505
506
507
508
509
510
511
512
513
514
515
516
517
# File 'lib/crimson-falcon/models/domain_incident.rb', line 505

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

Returns:

  • (String)

    String presentation of the object



493
494
495
# File 'lib/crimson-falcon/models/domain_incident.rb', line 493

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



359
360
361
362
363
364
365
366
367
368
369
# File 'lib/crimson-falcon/models/domain_incident.rb', line 359

def valid?
  return false if @cid.nil?
  return false if @created.nil?
  return false if @_end.nil?
  return false if @fine_score.nil?
  return false if @host_ids.nil?
  return false if @incident_id.nil?
  return false if @start.nil?
  return false if @state.nil?
  true
end