Class: Falcon::DeviceControlSettingsReqV1

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeviceControlSettingsReqV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

Instance Attribute Details

#classes ⇒ Object

Settings that apply to a USB Class



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

def classes
  @classes
end

#custom_notifications ⇒ Object

Returns the value of attribute custom_notifications.



38
39
40
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 38

def custom_notifications
  @custom_notifications
end

#delete_exceptions ⇒ Object

An array of exception IDs to delete from the policy



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

def delete_exceptions
  @delete_exceptions
end

#end_user_notification ⇒ Object

Does the end user receives a notification when the policy is violated



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

def end_user_notification
  @end_user_notification
end

#enforcement_mode ⇒ Object

How is this policy enforced



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

def enforcement_mode
  @enforcement_mode
end

#enhanced_file_metadata ⇒ Object

A bool value that enables file metadata functionality on the sensor or not



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

def enhanced_file_metadata
  @enhanced_file_metadata
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 75

def self.attribute_map
  {
    :'classes' => :'classes',
    :'custom_notifications' => :'custom_notifications',
    :'delete_exceptions' => :'delete_exceptions',
    :'end_user_notification' => :'end_user_notification',
    :'enforcement_mode' => :'enforcement_mode',
    :'enhanced_file_metadata' => :'enhanced_file_metadata'
  }
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



238
239
240
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 238

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 92

def self.openapi_types
  {
    :'classes' => :'Array<DeviceControlUSBClassExceptionsReqV1>',
    :'custom_notifications' => :'DeviceControlUSBCustomNotifications',
    :'delete_exceptions' => :'Array<String>',
    :'end_user_notification' => :'String',
    :'enforcement_mode' => :'String',
    :'enhanced_file_metadata' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      classes == o.classes &&
      custom_notifications == o.custom_notifications &&
      delete_exceptions == o.delete_exceptions &&
      end_user_notification == o.end_user_notification &&
      enforcement_mode == o.enforcement_mode &&
      enhanced_file_metadata == o.enhanced_file_metadata
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



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

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 340

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 245

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


225
226
227
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 231

def hash
  [classes, custom_notifications, delete_exceptions, end_user_notification, enforcement_mode, enhanced_file_metadata].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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 155

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

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

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

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



316
317
318
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 316

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 322

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



310
311
312
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 310

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



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/crimson-falcon/models/device_control_settings_req_v1.rb', line 178

def valid?
  return false if @classes.nil?
  return false if @delete_exceptions.nil?
  return false if @end_user_notification.nil?
  end_user_notification_validator = EnumAttributeValidator.new('String', ["SILENT", "NOTIFY_USER"])
  return false unless end_user_notification_validator.valid?(@end_user_notification)
  return false if @enforcement_mode.nil?
  enforcement_mode_validator = EnumAttributeValidator.new('String', ["MONITOR_ONLY", "MONITOR_ENFORCE"])
  return false unless enforcement_mode_validator.valid?(@enforcement_mode)
  true
end