Class: IntersightClient::EquipmentSharedIoModule

Inherits:
EquipmentBase show all
Defined in:
lib/intersight_client/models/equipment_shared_io_module.rb

Overview

I/O Controller present inside SIOC to provide data path from S-series server to FI.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from EquipmentBase

#model, #presence, #previous_fru, #revision, #serial, #vendor

Attributes inherited from InventoryBase

#device_mo_id, #dn, #rn

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EquipmentSharedIoModule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
244
245
246
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 161

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::EquipmentSharedIoModule` 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.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'equipment.SharedIoModule'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'equipment.SharedIoModule'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 20

def class_id
  @class_id
end

#config_state ⇒ Object

This field identifies the configuration state for this SIOM Unit.



26
27
28
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 26

def config_state
  @config_state
end

#controller ⇒ Object

Returns the value of attribute controller.



52
53
54
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 52

def controller
  @controller
end

#discovery ⇒ Object

This field identifies the discovery state of SIOM.



29
30
31
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 29

def discovery
  @discovery
end

#equipment_system_io_controller ⇒ Object

Returns the value of attribute equipment_system_io_controller.



54
55
56
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 54

def equipment_system_io_controller
  @equipment_system_io_controller
end

#inventory_device_info ⇒ Object

Returns the value of attribute inventory_device_info.



56
57
58
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 56

def inventory_device_info
  @inventory_device_info
end

#mac_of_shared_iom_aside ⇒ Object

This field identifies the MAC of IOM-A side.



32
33
34
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 32

def mac_of_shared_iom_aside
  @mac_of_shared_iom_aside
end

#mac_of_shared_iom_bside ⇒ Object

This field identifies the MAC of IOM-B side.



35
36
37
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 35

def mac_of_shared_iom_bside
  @mac_of_shared_iom_bside
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 23

def object_type
  @object_type
end

#oper_state ⇒ Object

This field identifies the SIOM operational state.



38
39
40
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 38

def oper_state
  @oper_state
end

#part_number ⇒ Object

This field identifies the Part Number for this SIOM Unit.



41
42
43
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 41

def part_number
  @part_number
end

#port_groups ⇒ Object

An array of relationships to portGroup resources.



59
60
61
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 59

def port_groups
  @port_groups
end

#reachability ⇒ Object

This field identifies the reachability to FI-A and B side.



44
45
46
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 44

def reachability
  @reachability
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



61
62
63
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 61

def registered_device
  @registered_device
end

#usr_lbl ⇒ Object

User label configured for the SIOM.



47
48
49
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 47

def usr_lbl
  @usr_lbl
end

#vid ⇒ Object

This field identifies the vendor id for this SIOM Unit.



50
51
52
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 50

def vid
  @vid
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



113
114
115
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 113

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



108
109
110
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 108

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 86

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'config_state' => :'ConfigState',
    :'discovery' => :'Discovery',
    :'mac_of_shared_iom_aside' => :'MacOfSharedIomAside',
    :'mac_of_shared_iom_bside' => :'MacOfSharedIomBside',
    :'oper_state' => :'OperState',
    :'part_number' => :'PartNumber',
    :'reachability' => :'Reachability',
    :'usr_lbl' => :'UsrLbl',
    :'vid' => :'Vid',
    :'controller' => :'Controller',
    :'equipment_system_io_controller' => :'EquipmentSystemIoController',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'port_groups' => :'PortGroups',
    :'registered_device' => :'RegisteredDevice'
  }
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



333
334
335
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 333

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



147
148
149
150
151
152
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 147

def self.openapi_all_of
  [
  :'EquipmentBase',
  :'EquipmentSharedIoModuleAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



155
156
157
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 155

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



140
141
142
143
144
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 140

def self.openapi_nullable
  Set.new([
    :'port_groups',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 118

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'config_state' => :'String',
    :'discovery' => :'String',
    :'mac_of_shared_iom_aside' => :'String',
    :'mac_of_shared_iom_bside' => :'String',
    :'oper_state' => :'String',
    :'part_number' => :'String',
    :'reachability' => :'String',
    :'usr_lbl' => :'String',
    :'vid' => :'String',
    :'controller' => :'ManagementControllerRelationship',
    :'equipment_system_io_controller' => :'EquipmentSystemIoControllerRelationship',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'port_groups' => :'Array<PortGroupRelationship>',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 297

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      config_state == o.config_state &&
      discovery == o.discovery &&
      mac_of_shared_iom_aside == o.mac_of_shared_iom_aside &&
      mac_of_shared_iom_bside == o.mac_of_shared_iom_bside &&
      oper_state == o.oper_state &&
      part_number == o.part_number &&
      reachability == o.reachability &&
      usr_lbl == o.usr_lbl &&
      vid == o.vid &&
      controller == o.controller &&
      equipment_system_io_controller == o.equipment_system_io_controller &&
      inventory_device_info == o.inventory_device_info &&
      port_groups == o.port_groups &&
      registered_device == o.registered_device && super(o)
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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 364

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 = IntersightClient.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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 435

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 340

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  EquipmentSharedIoModule.openapi_types.each_pair do |key, type|
    if attributes[EquipmentSharedIoModule.attribute_map[key]].nil? && EquipmentSharedIoModule.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[EquipmentSharedIoModule.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[EquipmentSharedIoModule.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[EquipmentSharedIoModule.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[EquipmentSharedIoModule.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


320
321
322
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 320

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



326
327
328
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 326

def hash
  [class_id, object_type, config_state, discovery, mac_of_shared_iom_aside, mac_of_shared_iom_bside, oper_state, part_number, reachability, usr_lbl, vid, controller, equipment_system_io_controller, inventory_device_info, port_groups, registered_device].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



250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 250

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

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



411
412
413
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 411

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 417

def to_hash
  hash = super
  EquipmentSharedIoModule.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = EquipmentSharedIoModule.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



405
406
407
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 405

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



265
266
267
268
269
270
271
272
273
 
# File 'lib/intersight_client/models/equipment_shared_io_module.rb', line 265

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["equipment.SharedIoModule"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["equipment.SharedIoModule"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end