Class: Falcon::DomainAPIRuleDetailsV1

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainAPIRuleDetailsV1

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
193
194
195
196
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_information ⇒ Object

Returns the value of attribute additional_information.



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

def additional_information
  @additional_information
end

#applicable_profiles ⇒ Object

Returns the value of attribute applicable_profiles.



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

def applicable_profiles
  @applicable_profiles
end

#assessment_status ⇒ Object

Returns the value of attribute assessment_status.



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

def assessment_status
  @assessment_status
end

#audit_procedure ⇒ Object

Returns the value of attribute audit_procedure.



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

def audit_procedure
  @audit_procedure
end

#authority ⇒ Object

Returns the value of attribute authority.



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

def authority
  @authority
end

#benchmark_title ⇒ Object

Returns the value of attribute benchmark_title.



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

def benchmark_title
  @benchmark_title
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#impact_statement ⇒ Object

Returns the value of attribute impact_statement.



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

def impact_statement
  @impact_statement
end

#platform ⇒ Object

Returns the value of attribute platform.



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

def platform
  @platform
end

#rationale_statement ⇒ Object

Returns the value of attribute rationale_statement.



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

def rationale_statement
  @rationale_statement
end

#recommendation_id ⇒ Object

Returns the value of attribute recommendation_id.



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

def recommendation_id
  @recommendation_id
end

#references ⇒ Object

Returns the value of attribute references.



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

def references
  @references
end

#remediation_procedure ⇒ Object

Returns the value of attribute remediation_procedure.



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

def remediation_procedure
  @remediation_procedure
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
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_details_v1.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_details_v1.rb', line 66

def self.attribute_map
  {
    :'additional_information' => :'additional_information',
    :'applicable_profiles' => :'applicable_profiles',
    :'assessment_status' => :'assessment_status',
    :'audit_procedure' => :'audit_procedure',
    :'authority' => :'authority',
    :'benchmark_title' => :'benchmark_title',
    :'description' => :'description',
    :'id' => :'id',
    :'impact_statement' => :'impact_statement',
    :'platform' => :'platform',
    :'rationale_statement' => :'rationale_statement',
    :'recommendation_id' => :'recommendation_id',
    :'references' => :'references',
    :'remediation_procedure' => :'remediation_procedure',
    :'title' => :'title'
  }
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



318
319
320
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 318

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_details_v1.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_details_v1.rb', line 92

def self.openapi_types
  {
    :'additional_information' => :'String',
    :'applicable_profiles' => :'Array<String>',
    :'assessment_status' => :'String',
    :'audit_procedure' => :'String',
    :'authority' => :'String',
    :'benchmark_title' => :'String',
    :'description' => :'String',
    :'id' => :'String',
    :'impact_statement' => :'String',
    :'platform' => :'String',
    :'rationale_statement' => :'String',
    :'recommendation_id' => :'String',
    :'references' => :'Array<String>',
    :'remediation_procedure' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 283

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_information == o.additional_information &&
      applicable_profiles == o.applicable_profiles &&
      assessment_status == o.assessment_status &&
      audit_procedure == o.audit_procedure &&
      authority == o.authority &&
      benchmark_title == o.benchmark_title &&
      description == o.description &&
      id == o.id &&
      impact_statement == o.impact_statement &&
      platform == o.platform &&
      rationale_statement == o.rationale_statement &&
      recommendation_id == o.recommendation_id &&
      references == o.references &&
      remediation_procedure == o.remediation_procedure &&
      title == o.title
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



349
350
351
352
353
354
355
356
357
358
359
360
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
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 349

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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 420

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 325

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


305
306
307
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 305

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



311
312
313
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 311

def hash
  [additional_information, applicable_profiles, assessment_status, audit_procedure, authority, benchmark_title, description, id, impact_statement, platform, rationale_statement, recommendation_id, references, remediation_procedure, title].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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



396
397
398
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 396

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 402

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



390
391
392
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 390

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/crimson-falcon/models/domain_api_rule_details_v1.rb', line 263

def valid?
  return false if @additional_information.nil?
  return false if @applicable_profiles.nil?
  return false if @assessment_status.nil?
  return false if @audit_procedure.nil?
  return false if @authority.nil?
  return false if @benchmark_title.nil?
  return false if @description.nil?
  return false if @id.nil?
  return false if @impact_statement.nil?
  return false if @platform.nil?
  return false if @rationale_statement.nil?
  return false if @recommendation_id.nil?
  return false if @remediation_procedure.nil?
  return false if @title.nil?
  true
end