Class: SwaggerClient::PolicyRule

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PolicyRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 116

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

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

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

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

Instance Attribute Details

#assets ⇒ Object

Returns the value of attribute assets.



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

def assets
  @assets
end

#benchmark ⇒ Object

Returns the value of attribute benchmark.



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

def benchmark
  @benchmark
end

#description ⇒ Object

A description of the rule.



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

def description
  @description
end

#id ⇒ Object

The textual representation of the policy rule identifier.



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

def id
  @id
end

#is_custom ⇒ Object

A flag indicating whether the policy rule is custom.



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

def is_custom
  @is_custom
end

#links ⇒ Object

Hypermedia links to corresponding or related resources.



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

def links
  @links
end

#name ⇒ Object

The name of the rule.



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

def name
  @name
end

#role ⇒ Object

The role of the policy rule. It’s value determines how it’s results affect compliance.



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

def role
  @role
end

#scope ⇒ Object

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



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

def scope
  @scope
end

#status ⇒ Object

The overall compliance status of the policy rule.



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

def status
  @status
end

#surrogate_id ⇒ Object

The identifier of the policy rule.



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

def surrogate_id
  @surrogate_id
end

#title ⇒ Object

The title of the policy rule as visible to the user.



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 73

def self.attribute_map
  {
    :'assets' => :'assets',
    :'benchmark' => :'benchmark',
    :'description' => :'description',
    :'id' => :'id',
    :'is_custom' => :'isCustom',
    :'links' => :'links',
    :'name' => :'name',
    :'role' => :'role',
    :'scope' => :'scope',
    :'status' => :'status',
    :'surrogate_id' => :'surrogateId',
    :'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



251
252
253
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 251

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 91

def self.openapi_types
  {
    :'assets' => :'Object',
    :'benchmark' => :'Object',
    :'description' => :'Object',
    :'id' => :'Object',
    :'is_custom' => :'Object',
    :'links' => :'Object',
    :'name' => :'Object',
    :'role' => :'Object',
    :'scope' => :'Object',
    :'status' => :'Object',
    :'surrogate_id' => :'Object',
    :'title' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assets == o.assets &&
      benchmark == o.benchmark &&
      description == o.description &&
      id == o.id &&
      is_custom == o.is_custom &&
      links == o.links &&
      name == o.name &&
      role == o.role &&
      scope == o.scope &&
      status == o.status &&
      surrogate_id == o.surrogate_id &&
      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



281
282
283
284
285
286
287
288
289
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
315
316
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 281

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 350

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 258

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


238
239
240
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 244

def hash
  [assets, benchmark, description, id, is_custom, links, name, role, scope, status, surrogate_id, 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



182
183
184
185
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 182

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



326
327
328
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 326

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 332

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



320
321
322
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 320

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



189
190
191
192
193
194
195
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_rule.rb', line 189

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