Class: MistApi::WlanQos

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/mist_api/models/wlan_qos.rb

Overview

WlanQos Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(mclass = WlanQosClassEnum::BEST_EFFORT, overwrite = false) ⇒ WlanQos

Returns a new instance of WlanQos.



41
42
43
44
 
# File 'lib/mist_api/models/wlan_qos.rb', line 41

def initialize(mclass = WlanQosClassEnum::BEST_EFFORT, overwrite = false)
  @mclass = mclass unless mclass == SKIP
  @overwrite = overwrite unless overwrite == SKIP
end

Instance Attribute Details

#mclass ⇒ WlanQosClassEnum

enum: ‘background`, `best_effort`, `video`, `voice`

Returns:



14
15
16
 
# File 'lib/mist_api/models/wlan_qos.rb', line 14

def mclass
  @mclass
end

#overwrite ⇒ TrueClass | FalseClass

Whether to overwrite QoS

Returns:

  • (TrueClass | FalseClass) 


18
19
20
 
# File 'lib/mist_api/models/wlan_qos.rb', line 18

def overwrite
  @overwrite
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/mist_api/models/wlan_qos.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  mclass = hash['class'] ||= WlanQosClassEnum::BEST_EFFORT
  overwrite = hash['overwrite'] ||= false

  # Create object from extracted values.
  WlanQos.new(mclass,
              overwrite)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/mist_api/models/wlan_qos.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['mclass'] = 'class'
  @_hash['overwrite'] = 'overwrite'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/mist_api/models/wlan_qos.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/mist_api/models/wlan_qos.rb', line 29

def self.optionals
  %w[
    mclass
    overwrite
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (WlanQos | Hash) —

    value against the validation is performed.



61
62
63
64
65
66
67
 
# File 'lib/mist_api/models/wlan_qos.rb', line 61

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



76
77
78
79
 
# File 'lib/mist_api/models/wlan_qos.rb', line 76

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} mclass: #{@mclass.inspect}, overwrite: #{@overwrite.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



70
71
72
73
 
# File 'lib/mist_api/models/wlan_qos.rb', line 70

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} mclass: #{@mclass}, overwrite: #{@overwrite}>"
end