Class: Falcon::DomainAPIRuleMetadata

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainAPIRuleMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assessment_status ⇒ Object

Returns the value of attribute assessment_status.



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

def assessment_status
  @assessment_status
end

#asset_type ⇒ Object

Returns the value of attribute asset_type.



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

def asset_type
  @asset_type
end

#audit_procedure ⇒ Object

Returns the value of attribute audit_procedure.



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

def audit_procedure
  @audit_procedure
end

#default_value ⇒ Object

Returns the value of attribute default_value.



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

def default_value
  @default_value
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#framework_name ⇒ Object

Returns the value of attribute framework_name.



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

def framework_name
  @framework_name
end

#framework_name_version ⇒ Object

Returns the value of attribute framework_name_version.



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

def framework_name_version
  @framework_name_version
end

#framework_version ⇒ Object

Returns the value of attribute framework_version.



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

def framework_version
  @framework_version
end

#impact ⇒ Object

Returns the value of attribute impact.



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

def impact
  @impact
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#recommendation_no ⇒ Object

Returns the value of attribute recommendation_no.



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

def recommendation_no
  @recommendation_no
end

#references ⇒ Object

Returns the value of attribute references.



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

def references
  @references
end

#remediation ⇒ Object

Returns the value of attribute remediation.



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

def remediation
  @remediation
end

#rule_id ⇒ Object

Returns the value of attribute rule_id.



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

def rule_id
  @rule_id
end

#severity ⇒ Object

Returns the value of attribute severity.



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

def severity
  @severity
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 66

def self.attribute_map
  {
    :'assessment_status' => :'assessment_status',
    :'asset_type' => :'asset_type',
    :'audit_procedure' => :'audit_procedure',
    :'default_value' => :'default_value',
    :'description' => :'description',
    :'framework_name' => :'framework_name',
    :'framework_name_version' => :'framework_name_version',
    :'framework_version' => :'framework_version',
    :'impact' => :'impact',
    :'name' => :'name',
    :'recommendation_no' => :'recommendation_no',
    :'references' => :'references',
    :'remediation' => :'remediation',
    :'rule_id' => :'rule_id',
    :'severity' => :'severity'
  }
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



289
290
291
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 289

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 92

def self.openapi_types
  {
    :'assessment_status' => :'String',
    :'asset_type' => :'String',
    :'audit_procedure' => :'String',
    :'default_value' => :'String',
    :'description' => :'String',
    :'framework_name' => :'String',
    :'framework_name_version' => :'String',
    :'framework_version' => :'String',
    :'impact' => :'String',
    :'name' => :'String',
    :'recommendation_no' => :'String',
    :'references' => :'String',
    :'remediation' => :'String',
    :'rule_id' => :'String',
    :'severity' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assessment_status == o.assessment_status &&
      asset_type == o.asset_type &&
      audit_procedure == o.audit_procedure &&
      default_value == o.default_value &&
      description == o.description &&
      framework_name == o.framework_name &&
      framework_name_version == o.framework_name_version &&
      framework_version == o.framework_version &&
      impact == o.impact &&
      name == o.name &&
      recommendation_no == o.recommendation_no &&
      references == o.references &&
      remediation == o.remediation &&
      rule_id == o.rule_id &&
      severity == o.severity
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



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
356
357
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 320

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 391

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



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

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


276
277
278
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 282

def hash
  [assessment_status, asset_type, audit_procedure, default_value, description, framework_name, framework_name_version, framework_version, impact, name, recommendation_no, references, remediation, rule_id, severity].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



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

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

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

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

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

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

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

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

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

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



367
368
369
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 373

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



361
362
363
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 361

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



239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/crimson-falcon/models/domain_api_rule_metadata.rb', line 239

def valid?
  return false if @assessment_status.nil?
  return false if @asset_type.nil?
  return false if @description.nil?
  return false if @impact.nil?
  return false if @name.nil?
  return false if @recommendation_no.nil?
  return false if @remediation.nil?
  return false if @rule_id.nil?
  return false if @severity.nil?
  true
end