Class: MistApi::VirtualChassisConfig

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

Overview

Virtual Chassis

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(locating = SKIP, members = SKIP, preprovisioned = false, additional_properties = nil) ⇒ VirtualChassisConfig

Returns a new instance of VirtualChassisConfig.



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

def initialize(locating = SKIP, members = SKIP, preprovisioned = false,
               additional_properties = nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @locating = locating unless locating == SKIP
  @members = members unless members == SKIP
  @preprovisioned = preprovisioned unless preprovisioned == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#locating ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def locating
  @locating
end

#members ⇒ Array[VirtualChassisConfigMember]

TODO: Write general description for this method

Returns:



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

def members
  @members
end

#preprovisioned ⇒ TrueClass | FalseClass

To create the Virtual Chassis in Pre-Provisioned mode

Returns:

  • (TrueClass | FalseClass) 


22
23
24
 
# File 'lib/mist_api/models/virtual_chassis_config.rb', line 22

def preprovisioned
  @preprovisioned
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mist_api/models/virtual_chassis_config.rb', line 59

def self.from_hash(hash)
  return nil unless hash

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

  members = SKIP unless hash.key?('members')
  preprovisioned = hash['preprovisioned'] ||= false

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  VirtualChassisConfig.new(locating,
                           members,
                           preprovisioned,
                           additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/mist_api/models/virtual_chassis_config.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['locating'] = 'locating'
  @_hash['members'] = 'members'
  @_hash['preprovisioned'] = 'preprovisioned'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/mist_api/models/virtual_chassis_config.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/mist_api/models/virtual_chassis_config.rb', line 34

def self.optionals
  %w[
    locating
    members
    preprovisioned
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



98
99
100
101
102
103
 
# File 'lib/mist_api/models/virtual_chassis_config.rb', line 98

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} locating: #{@locating.inspect}, members: #{@members.inspect},"\
  " preprovisioned: #{@preprovisioned.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



91
92
93
94
95
 
# File 'lib/mist_api/models/virtual_chassis_config.rb', line 91

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} locating: #{@locating}, members: #{@members}, preprovisioned:"\
  " #{@preprovisioned}, additional_properties: #{@additional_properties}>"
end