Class: Falcon::DevicecontrolapiRespPolicyV2

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DevicecontrolapiRespPolicyV2

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assignment_type ⇒ Object

Default or Automatic



36
37
38
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 36

def assignment_type
  @assignment_type
end

#bluetooth_channel_version ⇒ Object

Bluetooth channel file version number



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

def bluetooth_channel_version
  @bluetooth_channel_version
end

#bluetooth_settings ⇒ Object

Returns the value of attribute bluetooth_settings.



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

def bluetooth_settings
  @bluetooth_settings
end

#cid ⇒ Object

Customer ID of the policy



44
45
46
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 44

def cid
  @cid
end

#created_by ⇒ Object

CS username who created the policy



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

def created_by
  @created_by
end

#created_timestamp ⇒ Object

UTC time policy created



50
51
52
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 50

def created_timestamp
  @created_timestamp
end

#description ⇒ Object

Description of the policy



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

def description
  @description
end

#enabled ⇒ Object

Policy level enablement of the policy



56
57
58
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 56

def enabled
  @enabled
end

#groups ⇒ Object

Host group IDs assigned to this policy



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

def groups
  @groups
end

#id ⇒ Object

ID of the policy



62
63
64
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 62

def id
  @id
end

#modified_by ⇒ Object

Last CS username who modified the policy



65
66
67
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 65

def modified_by
  @modified_by
end

#modified_timestamp ⇒ Object

UTC time policy modified



68
69
70
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 68

def modified_timestamp
  @modified_timestamp
end

#name ⇒ Object

Name of the policy



71
72
73
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 71

def name
  @name
end

#platform_id ⇒ Object

The platform numeric value. Windows:0, MacOS:1



74
75
76
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 74

def platform_id
  @platform_id
end

#platform_name ⇒ Object

Policy platform name (Windows or Mac)



77
78
79
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 77

def platform_name
  @platform_name
end

#precedence ⇒ Object

Order in which a policy is applied (lower values is higher precedence)



80
81
82
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 80

def precedence
  @precedence
end

#settings_hash ⇒ Object

The hash of hostgroups assigned to the policy



83
84
85
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 83

def settings_hash
  @settings_hash
end

#usb_channel_version ⇒ Object

USB channel file version number



86
87
88
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 86

def usb_channel_version
  @usb_channel_version
end

#usb_settings ⇒ Object

Returns the value of attribute usb_settings.



88
89
90
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 88

def usb_settings
  @usb_settings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



116
117
118
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 91

def self.attribute_map
  {
    :'assignment_type' => :'assignment_type',
    :'bluetooth_channel_version' => :'bluetooth_channel_version',
    :'bluetooth_settings' => :'bluetooth_settings',
    :'cid' => :'cid',
    :'created_by' => :'created_by',
    :'created_timestamp' => :'created_timestamp',
    :'description' => :'description',
    :'enabled' => :'enabled',
    :'groups' => :'groups',
    :'id' => :'id',
    :'modified_by' => :'modified_by',
    :'modified_timestamp' => :'modified_timestamp',
    :'name' => :'name',
    :'platform_id' => :'platform_id',
    :'platform_name' => :'platform_name',
    :'precedence' => :'precedence',
    :'settings_hash' => :'settings_hash',
    :'usb_channel_version' => :'usb_channel_version',
    :'usb_settings' => :'usb_settings'
  }
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



374
375
376
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 374

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 146

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

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 121

def self.openapi_types
  {
    :'assignment_type' => :'String',
    :'bluetooth_channel_version' => :'Integer',
    :'bluetooth_settings' => :'DevicecontrolapiBluetoothSettings',
    :'cid' => :'String',
    :'created_by' => :'String',
    :'created_timestamp' => :'String',
    :'description' => :'String',
    :'enabled' => :'Boolean',
    :'groups' => :'Array<String>',
    :'id' => :'String',
    :'modified_by' => :'String',
    :'modified_timestamp' => :'String',
    :'name' => :'String',
    :'platform_id' => :'String',
    :'platform_name' => :'String',
    :'precedence' => :'Integer',
    :'settings_hash' => :'String',
    :'usb_channel_version' => :'Integer',
    :'usb_settings' => :'DevicecontrolapiRespUSBSettingsV2'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 335

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assignment_type == o.assignment_type &&
      bluetooth_channel_version == o.bluetooth_channel_version &&
      bluetooth_settings == o.bluetooth_settings &&
      cid == o.cid &&
      created_by == o.created_by &&
      created_timestamp == o.created_timestamp &&
      description == o.description &&
      enabled == o.enabled &&
      groups == o.groups &&
      id == o.id &&
      modified_by == o.modified_by &&
      modified_timestamp == o.modified_timestamp &&
      name == o.name &&
      platform_id == o.platform_id &&
      platform_name == o.platform_name &&
      precedence == o.precedence &&
      settings_hash == o.settings_hash &&
      usb_channel_version == o.usb_channel_version &&
      usb_settings == o.usb_settings
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



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 405

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



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 476

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



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 381

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


361
362
363
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



367
368
369
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 367

def hash
  [assignment_type, bluetooth_channel_version, bluetooth_settings, cid, created_by, created_timestamp, description, enabled, groups, id, modified_by, modified_timestamp, name, platform_id, platform_name, precedence, settings_hash, usb_channel_version, usb_settings].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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 247

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



452
453
454
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 452

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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 458

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



446
447
448
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 446

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/crimson-falcon/models/devicecontrolapi_resp_policy_v2.rb', line 314

def valid?
  return false if @assignment_type.nil?
  return false if @cid.nil?
  return false if @created_by.nil?
  return false if @created_timestamp.nil?
  return false if @enabled.nil?
  return false if @groups.nil?
  return false if @id.nil?
  return false if @modified_by.nil?
  return false if @modified_timestamp.nil?
  return false if @name.nil?
  return false if @platform_id.nil?
  return false if @platform_name.nil?
  return false if @precedence.nil?
  return false if @usb_channel_version.nil?
  return false if @usb_settings.nil?
  true
end