Class: Falcon::DomainAPIAggregationGroupByRulesResultV1

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainAPIAggregationGroupByRulesResultV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
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
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 108

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_type ⇒ Object

Returns the value of attribute asset_type.



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

def asset_type
  @asset_type
end

#failed_assessment_count ⇒ Object

Returns the value of attribute failed_assessment_count.



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

def failed_assessment_count
  @failed_assessment_count
end

#framework_name ⇒ Object

Returns the value of attribute framework_name.



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

def framework_name
  @framework_name
end

#framework_name_version ⇒ Object

Returns the value of attribute framework_name_version.



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

def framework_name_version
  @framework_name_version
end

#framework_version ⇒ Object

Returns the value of attribute framework_version.



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

def framework_version
  @framework_version
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#passed_assessment_count ⇒ Object

Returns the value of attribute passed_assessment_count.



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

def passed_assessment_count
  @passed_assessment_count
end

#percentage_of_passed_assessments ⇒ Object

Returns the value of attribute percentage_of_passed_assessments.



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

def percentage_of_passed_assessments
  @percentage_of_passed_assessments
end

#recommendation_id ⇒ Object

Returns the value of attribute recommendation_id.



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

def recommendation_id
  @recommendation_id
end

#severity ⇒ Object

Returns the value of attribute severity.



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

def severity
  @severity
end

#total_assessment_count ⇒ Object

Returns the value of attribute total_assessment_count.



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

def total_assessment_count
  @total_assessment_count
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 60

def self.attribute_map
  {
    :'asset_type' => :'asset_type',
    :'failed_assessment_count' => :'failed_assessment_count',
    :'framework_name' => :'framework_name',
    :'framework_name_version' => :'framework_name_version',
    :'framework_version' => :'framework_version',
    :'id' => :'id',
    :'name' => :'name',
    :'passed_assessment_count' => :'passed_assessment_count',
    :'percentage_of_passed_assessments' => :'percentage_of_passed_assessments',
    :'recommendation_id' => :'recommendation_id',
    :'severity' => :'severity',
    :'total_assessment_count' => :'total_assessment_count'
  }
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



272
273
274
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 272

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 83

def self.openapi_types
  {
    :'asset_type' => :'String',
    :'failed_assessment_count' => :'Integer',
    :'framework_name' => :'String',
    :'framework_name_version' => :'String',
    :'framework_version' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'passed_assessment_count' => :'Integer',
    :'percentage_of_passed_assessments' => :'Float',
    :'recommendation_id' => :'String',
    :'severity' => :'Integer',
    :'total_assessment_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asset_type == o.asset_type &&
      failed_assessment_count == o.failed_assessment_count &&
      framework_name == o.framework_name &&
      framework_name_version == o.framework_name_version &&
      framework_version == o.framework_version &&
      id == o.id &&
      name == o.name &&
      passed_assessment_count == o.passed_assessment_count &&
      percentage_of_passed_assessments == o.percentage_of_passed_assessments &&
      recommendation_id == o.recommendation_id &&
      severity == o.severity &&
      total_assessment_count == o.total_assessment_count
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



303
304
305
306
307
308
309
310
311
312
313
314
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
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 303

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



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

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 279

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


259
260
261
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 265

def hash
  [asset_type, failed_assessment_count, framework_name, framework_name_version, framework_version, id, name, passed_assessment_count, percentage_of_passed_assessments, recommendation_id, severity, total_assessment_count].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



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 172

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

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

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

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

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

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

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

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

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

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

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



350
351
352
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 356

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



344
345
346
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 344

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/crimson-falcon/models/domain_api_aggregation_group_by_rules_result_v1.rb', line 223

def valid?
  return false if @asset_type.nil?
  return false if @failed_assessment_count.nil?
  return false if @framework_name.nil?
  return false if @framework_name_version.nil?
  return false if @framework_version.nil?
  return false if @name.nil?
  return false if @passed_assessment_count.nil?
  return false if @percentage_of_passed_assessments.nil?
  return false if @recommendation_id.nil?
  return false if @severity.nil?
  return false if @total_assessment_count.nil?
  true
end