Class: MistApi::SwitchMatching

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

Overview

Defines custom switch configuration based on different criteria

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(enable = SKIP, rules = SKIP) ⇒ SwitchMatching

Returns a new instance of SwitchMatching.



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

def initialize(enable = SKIP, rules = SKIP)
  @enable = enable unless enable == SKIP
  @rules = rules unless rules == SKIP
end

Instance Attribute Details

#enable ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def enable
  @enable
end

#rules ⇒ Array[SwitchMatchingRule]

TODO: Write general description for this method

Returns:



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

def rules
  @rules
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
58
59
60
61
62
63
64
65
66
 
# File 'lib/mist_api/models/switch_matching.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  enable = hash.key?('enable') ? hash['enable'] : SKIP
  # Parameter is an array, so we need to iterate through it
  rules = nil
  unless hash['rules'].nil?
    rules = []
    hash['rules'].each do |structure|
      rules << (SwitchMatchingRule.from_hash(structure) if structure)
    end
  end

  rules = SKIP unless hash.key?('rules')

  # Create object from extracted values.
  SwitchMatching.new(enable,
                     rules)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['enable'] = 'enable'
  @_hash['rules'] = 'rules'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/mist_api/models/switch_matching.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/switch_matching.rb', line 29

def self.optionals
  %w[
    enable
    rules
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



75
76
77
78
 
# File 'lib/mist_api/models/switch_matching.rb', line 75

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



69
70
71
72
 
# File 'lib/mist_api/models/switch_matching.rb', line 69

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