Class: SwaggerClient::AssetPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
260
261
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 163

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#benchmark_name ⇒ Object

The name of the policy’s benchmark.



17
18
19
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 17

def benchmark_name
  @benchmark_name
end

#benchmark_version ⇒ Object

The version number of the benchmark that includes the policy.



20
21
22
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 20

def benchmark_version
  @benchmark_version
end

#category ⇒ Object

A grouping of similar benchmarks based on their source, purpose, or other criteria. Examples include FDCC, USGCB, and CIS.



23
24
25
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 23

def category
  @category
end

#description ⇒ Object

The description of the policy.



26
27
28
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 26

def description
  @description
end

#failed_assets_count ⇒ Object

The number of assets that are not compliant with the policy. The assets considered in the calculation are based on the user’s list of accessible assets.



29
30
31
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 29

def failed_assets_count
  @failed_assets_count
end

#failed_rules_count ⇒ Object

The number of rules in the policy that are not compliant with any scanned assets. The assets considered in the calculation are based on the user’s list of accessible assets.



32
33
34
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 32

def failed_rules_count
  @failed_rules_count
end

#id ⇒ Object

The textual representation of the policy identifier.



35
36
37
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 35

def id
  @id
end

#is_custom ⇒ Object

A flag indicating whether the policy is custom.



38
39
40
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 38

def is_custom
  @is_custom
end

#links ⇒ Object

Hypermedia links to corresponding or related resources.



41
42
43
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 41

def links
  @links
end

#not_applicable_assets_count ⇒ Object

The number of assets that were attempted to be scanned, but are not applicable to the policy. The assets considered in the calculation are based on the user’s list of accessible assets.



44
45
46
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 44

def not_applicable_assets_count
  @not_applicable_assets_count
end

#not_applicable_rules_count ⇒ Object

The number of rules in the policy that are not applicable with any scanned assets. The assets considered in the calculation are based on the user’s list of accessible assets.



47
48
49
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 47

def not_applicable_rules_count
  @not_applicable_rules_count
end

#passed_assets_count ⇒ Object

The number of assets that are compliant with the policy. The assets considered in the calculation are based on the user’s list of accessible assets.



50
51
52
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 50

def passed_assets_count
  @passed_assets_count
end

#passed_rules_count ⇒ Object

The number of rules in the policy that are compliant with all scanned assets. The assets considered in the calculation are based on the user’s list of accessible assets.



53
54
55
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 53

def passed_rules_count
  @passed_rules_count
end

#policy_name ⇒ Object

The name of the policy.



56
57
58
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 56

def policy_name
  @policy_name
end

#rule_compliance ⇒ Object

The ratio of PASS results for the rules to the total number of rules in each policy.



59
60
61
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 59

def rule_compliance
  @rule_compliance
end

#rule_compliance_delta ⇒ Object

The change in rule compliance between the last two scans of all assets. The list of scanned policies is based on the user’s list of accessible assets.



62
63
64
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 62

def rule_compliance_delta
  @rule_compliance_delta
end

#scope ⇒ Object

The textual representation of the policy scope. Policies that are automatically available have ‘"Built-in"` scope, whereas policies created by users have scope as `"Custom"`.



65
66
67
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 65

def scope
  @scope
end

#status ⇒ Object

The overall compliance status of the policy.



68
69
70
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 68

def status
  @status
end

#surrogate_id ⇒ Object

The identifier of the policy



71
72
73
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 71

def surrogate_id
  @surrogate_id
end

#title ⇒ Object

The title of the policy as visible to the user.



74
75
76
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 74

def title
  @title
end

#unscored_rules ⇒ Object

The number of rules defined in the policy with a role of "unscored". These rules will not affect rule compliance scoring for the policy.



77
78
79
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 77

def unscored_rules
  @unscored_rules
end

Class Method Details

.attribute_map ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 102

def self.attribute_map
  {
    :'benchmark_name' => :'benchmarkName',
    :'benchmark_version' => :'benchmarkVersion',
    :'category' => :'category',
    :'description' => :'description',
    :'failed_assets_count' => :'failedAssetsCount',
    :'failed_rules_count' => :'failedRulesCount',
    :'id' => :'id',
    :'is_custom' => :'isCustom',
    :'links' => :'links',
    :'not_applicable_assets_count' => :'notApplicableAssetsCount',
    :'not_applicable_rules_count' => :'notApplicableRulesCount',
    :'passed_assets_count' => :'passedAssetsCount',
    :'passed_rules_count' => :'passedRulesCount',
    :'policy_name' => :'policyName',
    :'rule_compliance' => :'ruleCompliance',
    :'rule_compliance_delta' => :'ruleComplianceDelta',
    :'scope' => :'scope',
    :'status' => :'status',
    :'surrogate_id' => :'surrogateId',
    :'title' => :'title',
    :'unscored_rules' => :'unscoredRules'
  }
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



331
332
333
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 331

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



156
157
158
159
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 156

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 129

def self.openapi_types
  {
    :'benchmark_name' => :'Object',
    :'benchmark_version' => :'Object',
    :'category' => :'Object',
    :'description' => :'Object',
    :'failed_assets_count' => :'Object',
    :'failed_rules_count' => :'Object',
    :'id' => :'Object',
    :'is_custom' => :'Object',
    :'links' => :'Object',
    :'not_applicable_assets_count' => :'Object',
    :'not_applicable_rules_count' => :'Object',
    :'passed_assets_count' => :'Object',
    :'passed_rules_count' => :'Object',
    :'policy_name' => :'Object',
    :'rule_compliance' => :'Object',
    :'rule_compliance_delta' => :'Object',
    :'scope' => :'Object',
    :'status' => :'Object',
    :'surrogate_id' => :'Object',
    :'title' => :'Object',
    :'unscored_rules' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      benchmark_name == o.benchmark_name &&
      benchmark_version == o.benchmark_version &&
      category == o.category &&
      description == o.description &&
      failed_assets_count == o.failed_assets_count &&
      failed_rules_count == o.failed_rules_count &&
      id == o.id &&
      is_custom == o.is_custom &&
      links == o.links &&
      not_applicable_assets_count == o.not_applicable_assets_count &&
      not_applicable_rules_count == o.not_applicable_rules_count &&
      passed_assets_count == o.passed_assets_count &&
      passed_rules_count == o.passed_rules_count &&
      policy_name == o.policy_name &&
      rule_compliance == o.rule_compliance &&
      rule_compliance_delta == o.rule_compliance_delta &&
      scope == o.scope &&
      status == o.status &&
      surrogate_id == o.surrogate_id &&
      title == o.title &&
      unscored_rules == o.unscored_rules
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 361

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    SwaggerClient.const_get(type).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



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 430

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 338

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


318
319
320
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



324
325
326
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 324

def hash
  [benchmark_name, benchmark_version, category, description, failed_assets_count, failed_rules_count, id, is_custom, links, not_applicable_assets_count, not_applicable_rules_count, passed_assets_count, passed_rules_count, policy_name, rule_compliance, rule_compliance_delta, scope, status, surrogate_id, title, unscored_rules].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



265
266
267
268
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 265

def list_invalid_properties
  invalid_properties = Array.new
  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



406
407
408
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 406

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 412

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



400
401
402
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 400

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



272
273
274
275
276
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/asset_policy.rb', line 272

def valid?
  status_validator = EnumAttributeValidator.new('Object', ['PASS', 'FAIL', 'NOT_APPLICABLE'])
  return false unless status_validator.valid?(@status)
  true
end