Class: Falcon::IoaRuleGroupsRuleGroupV1

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

Overview

An IOA rule group which contains a set of IOA rules

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoaRuleGroupsRuleGroupV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 129

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'modified_by')
    self.modified_by = attributes[:'modified_by']
  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?(:'platform')
    self.platform = attributes[:'platform']
  end

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

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

Instance Attribute Details

#comment ⇒ Object

Returns the value of attribute comment.



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

def comment
  @comment
end

#committed_timestamp ⇒ Object

The last attempted time CFS got this data on the rule group



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

def committed_timestamp
  @committed_timestamp
end

#created_by ⇒ Object

The email of the user which created the rule group



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

def created_by
  @created_by
end

#created_timestamp ⇒ Object

The time at which the policy was created



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

def created_timestamp
  @created_timestamp
end

#customer_id ⇒ Object

Returns the value of attribute customer_id.



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

def customer_id
  @customer_id
end

#deleted ⇒ Object

Returns the value of attribute deleted.



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

def deleted
  @deleted
end

#description ⇒ Object

An additional description of the group or the rules it contains



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

def description
  @description
end

#enabled ⇒ Object

Returns the value of attribute enabled.



54
55
56
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 54

def enabled
  @enabled
end

#id ⇒ Object

The identifier of this IOA rule group



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

def id
  @id
end

#modified_by ⇒ Object

The email of the user which last modified the rule group



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

def modified_by
  @modified_by
end

#modified_timestamp ⇒ Object

The time at which the policy was last modified



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

def modified_timestamp
  @modified_timestamp
end

#name ⇒ Object

The name of the group



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

def name
  @name
end

#platform ⇒ Object

Returns the value of attribute platform.



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

def platform
  @platform
end

#rule_ids ⇒ Object

Returns the value of attribute rule_ids.



70
71
72
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 70

def rule_ids
  @rule_ids
end

#version ⇒ Object

Returns the value of attribute version.



72
73
74
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 72

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'comment' => :'comment',
    :'committed_timestamp' => :'committed_timestamp',
    :'created_by' => :'created_by',
    :'created_timestamp' => :'created_timestamp',
    :'customer_id' => :'customer_id',
    :'deleted' => :'deleted',
    :'description' => :'description',
    :'enabled' => :'enabled',
    :'id' => :'id',
    :'modified_by' => :'modified_by',
    :'modified_timestamp' => :'modified_timestamp',
    :'name' => :'name',
    :'platform' => :'platform',
    :'rule_ids' => :'rule_ids',
    :'version' => :'version'
  }
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



330
331
332
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 330

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'comment' => :'String',
    :'committed_timestamp' => :'Time',
    :'created_by' => :'String',
    :'created_timestamp' => :'Time',
    :'customer_id' => :'String',
    :'deleted' => :'Boolean',
    :'description' => :'String',
    :'enabled' => :'Boolean',
    :'id' => :'String',
    :'modified_by' => :'String',
    :'modified_timestamp' => :'Time',
    :'name' => :'String',
    :'platform' => :'String',
    :'rule_ids' => :'Array<String>',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comment == o.comment &&
      committed_timestamp == o.committed_timestamp &&
      created_by == o.created_by &&
      created_timestamp == o.created_timestamp &&
      customer_id == o.customer_id &&
      deleted == o.deleted &&
      description == o.description &&
      enabled == o.enabled &&
      id == o.id &&
      modified_by == o.modified_by &&
      modified_timestamp == o.modified_timestamp &&
      name == o.name &&
      platform == o.platform &&
      rule_ids == o.rule_ids &&
      version == o.version
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



361
362
363
364
365
366
367
368
369
370
371
372
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
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 361

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 432

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 337

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


317
318
319
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 323

def hash
  [comment, committed_timestamp, created_by, created_timestamp, customer_id, deleted, description, enabled, id, modified_by, modified_timestamp, name, platform, rule_ids, version].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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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



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

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



402
403
404
 
# File 'lib/crimson-falcon/models/ioa_rule_groups_rule_group_v1.rb', line 402

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



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

def valid?
  return false if @comment.nil?
  return false if @committed_timestamp.nil?
  return false if @created_by.nil?
  return false if @created_timestamp.nil?
  return false if @customer_id.nil?
  return false if @deleted.nil?
  return false if @description.nil?
  return false if @enabled.nil?
  return false if @id.nil?
  return false if @modified_by.nil?
  return false if @modified_timestamp.nil?
  return false if @name.nil?
  return false if @platform.nil?
  return false if @rule_ids.nil?
  return false if @version.nil?
  true
end