Class: Falcon::DomainEvent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

The raw body of the event



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

def body
  @body
end

#body_is_truncated ⇒ Object

By default, event bodies are truncated to 64kb and bodyIsTruncated is set to True. For event bodies larger than 64kb, call the /events-full-body endpoint with the respective eventId



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

def body_is_truncated
  @body_is_truncated
end

#body_link ⇒ Object

Link to the event, can be missing



42
43
44
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 42

def body_link
  @body_link
end

#botnet_config_source ⇒ Object

Returns the value of attribute botnet_config_source.



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

def botnet_config_source
  @botnet_config_source
end

#created_date ⇒ Object

The date the event was created (in UTC format)



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

def created_date
  @created_date
end

#ddos_attack_source ⇒ Object

Returns the value of attribute ddos_attack_source.



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

def ddos_attack_source
  @ddos_attack_source
end

#event_type ⇒ Object

The type of event. One of ‘TweetEvent`, `CodePasteEvent`, `BotnetConfigEvent`, `DdosAttackEvent`



52
53
54
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 52

def event_type
  @event_type
end

#fingerprint ⇒ Object

The event’s fingerprint



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

def fingerprint
  @fingerprint
end

#id ⇒ Object

The unique event ID



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

def id
  @id
end

#matched_rules ⇒ Object

List of objects with rules that matched the event



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

def matched_rules
  @matched_rules
end

#pastebin_text_source ⇒ Object

Returns the value of attribute pastebin_text_source.



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

def pastebin_text_source
  @pastebin_text_source
end

#tags ⇒ Object

A list of tags summarizing event content



66
67
68
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 66

def tags
  @tags
end

#tweet_source ⇒ Object

Returns the value of attribute tweet_source.



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

def tweet_source
  @tweet_source
end

#updated_date ⇒ Object

The date the event was last updated (in UTC format)



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

def updated_date
  @updated_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 74

def self.attribute_map
  {
    :'body' => :'body',
    :'body_is_truncated' => :'body_is_truncated',
    :'body_link' => :'body_link',
    :'botnet_config_source' => :'botnet_config_source',
    :'created_date' => :'created_date',
    :'ddos_attack_source' => :'ddos_attack_source',
    :'event_type' => :'event_type',
    :'fingerprint' => :'fingerprint',
    :'id' => :'id',
    :'matched_rules' => :'matched_rules',
    :'pastebin_text_source' => :'pastebin_text_source',
    :'tags' => :'tags',
    :'tweet_source' => :'tweet_source',
    :'updated_date' => :'updated_date'
  }
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



284
285
286
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 284

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 99

def self.openapi_types
  {
    :'body' => :'String',
    :'body_is_truncated' => :'Boolean',
    :'body_link' => :'String',
    :'botnet_config_source' => :'DomainBotnetConfigSource',
    :'created_date' => :'String',
    :'ddos_attack_source' => :'DomainDDOSAttackSource',
    :'event_type' => :'String',
    :'fingerprint' => :'String',
    :'id' => :'String',
    :'matched_rules' => :'Array<DomainMatchedRule>',
    :'pastebin_text_source' => :'DomainPastebinTextSource',
    :'tags' => :'Array<String>',
    :'tweet_source' => :'DomainTweetSource',
    :'updated_date' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      body == o.body &&
      body_is_truncated == o.body_is_truncated &&
      body_link == o.body_link &&
      botnet_config_source == o.botnet_config_source &&
      created_date == o.created_date &&
      ddos_attack_source == o.ddos_attack_source &&
      event_type == o.event_type &&
      fingerprint == o.fingerprint &&
      id == o.id &&
      matched_rules == o.matched_rules &&
      pastebin_text_source == o.pastebin_text_source &&
      tags == o.tags &&
      tweet_source == o.tweet_source &&
      updated_date == o.updated_date
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



315
316
317
318
319
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
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 315

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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 386

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 291

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


271
272
273
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 277

def hash
  [body, body_is_truncated, body_link, botnet_config_source, created_date, ddos_attack_source, event_type, fingerprint, id, matched_rules, pastebin_text_source, tags, tweet_source, updated_date].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



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

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

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

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

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

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

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

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



362
363
364
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 368

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



356
357
358
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 356

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



237
238
239
240
241
242
243
244
245
246
 
# File 'lib/crimson-falcon/models/domain_event.rb', line 237

def valid?
  return false if @body.nil?
  return false if @body_is_truncated.nil?
  return false if @created_date.nil?
  return false if @event_type.nil?
  return false if @fingerprint.nil?
  return false if @id.nil?
  return false if @updated_date.nil?
  true
end