Class: SwaggerClient::PolicyItem

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PolicyItem

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  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_item.rb', line 16

def assets
  @assets
end

#description ⇒ Object

A description of the policy rule or group.



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

def description
  @description
end

#has_override ⇒ Object

A flag indicating whether the policy rule has an active override applied to it. This field only applies to resources representing policy rules.



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

def has_override
  @has_override
end

#id ⇒ Object

The identifier of the policy rule or group.



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

def id
  @id
end

#is_unscored ⇒ Object

A flag indicating whether the policy rule has a role of ‘"unscored"`. This field only applies to resources representing policy rules.



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

def is_unscored
  @is_unscored
end

#links ⇒ Object

Hypermedia links to corresponding or related resources.



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

def links
  @links
end

#name ⇒ Object

The name of the policy rule or group.



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

def name
  @name
end

#policy ⇒ Object

Returns the value of attribute policy.



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

def policy
  @policy
end

#rules ⇒ Object

Returns the value of attribute rules.



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

def rules
  @rules
end

#scope ⇒ Object

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



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

def scope
  @scope
end

#status ⇒ Object

The overall compliance status of the policy rule or group.



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

def status
  @status
end

#title ⇒ Object

The title of the policy rule, or group, as visible to the user.



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

def title
  @title
end

#type ⇒ Object

Indicates whether the resource represents either a policy rule or group.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'assets' => :'assets',
    :'description' => :'description',
    :'has_override' => :'hasOverride',
    :'id' => :'id',
    :'is_unscored' => :'isUnscored',
    :'links' => :'links',
    :'name' => :'name',
    :'policy' => :'policy',
    :'rules' => :'rules',
    :'scope' => :'scope',
    :'status' => :'status',
    :'title' => :'title',
    :'type' => :'type'
  }
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



260
261
262
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 260

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/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 94

def self.openapi_types
  {
    :'assets' => :'Object',
    :'description' => :'Object',
    :'has_override' => :'Object',
    :'id' => :'Object',
    :'is_unscored' => :'Object',
    :'links' => :'Object',
    :'name' => :'Object',
    :'policy' => :'Object',
    :'rules' => :'Object',
    :'scope' => :'Object',
    :'status' => :'Object',
    :'title' => :'Object',
    :'type' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assets == o.assets &&
      description == o.description &&
      has_override == o.has_override &&
      id == o.id &&
      is_unscored == o.is_unscored &&
      links == o.links &&
      name == o.name &&
      policy == o.policy &&
      rules == o.rules &&
      scope == o.scope &&
      status == o.status &&
      title == o.title &&
      type == o.type
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



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
317
318
319
320
321
322
323
324
325
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 290

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 359

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 267

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


247
248
249
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 253

def hash
  [assets, description, has_override, id, is_unscored, links, name, policy, rules, scope, status, title, type].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



190
191
192
193
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 190

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



335
336
337
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 335

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 341

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



329
330
331
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 329

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



197
198
199
200
201
202
203
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/policy_item.rb', line 197

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