Class: Falcon::ApiIndicatorCreateReqV1

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiIndicatorCreateReqV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Returns the value of attribute action.



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

def action
  @action
end

#applied_globally ⇒ Object

Returns the value of attribute applied_globally.



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

def applied_globally
  @applied_globally
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#expiration ⇒ Object

Returns the value of attribute expiration.



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

def expiration
  @expiration
end

#host_groups ⇒ Object

Returns the value of attribute host_groups.



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

def host_groups
  @host_groups
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#mobile_action ⇒ Object

Returns the value of attribute mobile_action.



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

def mobile_action
  @mobile_action
end

#platforms ⇒ Object

Returns the value of attribute platforms.



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

def platforms
  @platforms
end

#severity ⇒ Object

Returns the value of attribute severity.



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

def severity
  @severity
end

#source ⇒ Object

Returns the value of attribute source.



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

def source
  @source
end

#tags ⇒ Object

Returns the value of attribute tags.



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

def tags
  @tags
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 62

def self.attribute_map
  {
    :'action' => :'action',
    :'applied_globally' => :'applied_globally',
    :'description' => :'description',
    :'expiration' => :'expiration',
    :'host_groups' => :'host_groups',
    :'metadata' => :'metadata',
    :'mobile_action' => :'mobile_action',
    :'platforms' => :'platforms',
    :'severity' => :'severity',
    :'source' => :'source',
    :'tags' => :'tags',
    :'type' => :'type',
    :'value' => :'value'
  }
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



237
238
239
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 237

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'action' => :'String',
    :'applied_globally' => :'Boolean',
    :'description' => :'String',
    :'expiration' => :'Time',
    :'host_groups' => :'Array<String>',
    :'metadata' => :'ApiMetadataReqV1',
    :'mobile_action' => :'String',
    :'platforms' => :'Array<String>',
    :'severity' => :'String',
    :'source' => :'String',
    :'tags' => :'Array<String>',
    :'type' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      applied_globally == o.applied_globally &&
      description == o.description &&
      expiration == o.expiration &&
      host_groups == o.host_groups &&
      metadata == o.metadata &&
      mobile_action == o.mobile_action &&
      platforms == o.platforms &&
      severity == o.severity &&
      source == o.source &&
      tags == o.tags &&
      type == o.type &&
      value == o.value
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



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

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 339

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 244

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


224
225
226
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 230

def hash
  [action, applied_globally, description, expiration, host_groups, metadata, mobile_action, platforms, severity, source, tags, type, value].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



186
187
188
189
190
191
192
193
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  if @applied_globally.nil?
    invalid_properties.push('invalid value for "applied_globally", applied_globally 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



315
316
317
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 315

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 321

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



309
310
311
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 309

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



197
198
199
200
 
# File 'lib/crimson-falcon/models/api_indicator_create_req_v1.rb', line 197

def valid?
  return false if @applied_globally.nil?
  true
end