Class: IntersightClient::EquipmentSystemIoController

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

Overview

I/O Controller on a chassis which provides the data path to S-series server.

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 = {}) ⇒ EquipmentSystemIoController

Initializes the object

Parameters:

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

    Model attributes in the form of hash



159
160
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
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 159

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::EquipmentSystemIoController` 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.SystemIoController'
  end

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

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

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

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

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

  if attributes.key?(:'managing_instance')
    self.managing_instance = attributes[:'managing_instance']
  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?(:'pid')
    self.pid = attributes[:'pid']
  end

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

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

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

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

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

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

Instance Attribute Details

#chassis_idObject

The assigned identifier for a chassis.



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

def chassis_id
  @chassis_id
end

#class_idObject

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_system_io_controller.rb', line 20

def class_id
  @class_id
end

#cmcObject

Returns the value of attribute cmc.



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

def cmc
  @cmc
end

#connection_pathObject

Connection Path identifies the data path available between IOModule and FI.



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

def connection_path
  @connection_path
end

#connection_statusObject

Connection status identifies the status of data path.



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

def connection_status
  @connection_status
end

#descriptionObject

This field gives a brief information on systemIOController.



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

def description
  @description
end

#equipment_chassisObject

Returns the value of attribute equipment_chassis.



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

def equipment_chassis
  @equipment_chassis
end

#inventory_device_infoObject

Returns the value of attribute inventory_device_info.



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

def inventory_device_info
  @inventory_device_info
end

#managing_instanceObject

This field identifies the CIMC that manages the controller.



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

def managing_instance
  @managing_instance
end

#object_typeObject

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_system_io_controller.rb', line 23

def object_type
  @object_type
end

#oper_stateObject

This field identifies the SIOC operational state.



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

def oper_state
  @oper_state
end

#part_numberObject

Part Number identifier for the IO module.



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

def part_number
  @part_number
end

#pidObject

This field identifies the Product ID for systemIOController.



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

def pid
  @pid
end

#registered_deviceObject

Returns the value of attribute registered_device.



58
59
60
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 58

def registered_device
  @registered_device
end

#shared_io_moduleObject

Returns the value of attribute shared_io_module.



60
61
62
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 60

def shared_io_module
  @shared_io_module
end

#system_io_controller_idObject

This represents system I/O Controller identifier.



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

def system_io_controller_id
  @system_io_controller_id
end

Class Method Details

.acceptable_attribute_mapObject

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



112
113
114
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 112

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

.acceptable_attributesObject

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



107
108
109
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 107

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

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'chassis_id' => :'ChassisId',
    :'connection_path' => :'ConnectionPath',
    :'connection_status' => :'ConnectionStatus',
    :'description' => :'Description',
    :'managing_instance' => :'ManagingInstance',
    :'oper_state' => :'OperState',
    :'part_number' => :'PartNumber',
    :'pid' => :'Pid',
    :'system_io_controller_id' => :'SystemIoControllerId',
    :'cmc' => :'Cmc',
    :'equipment_chassis' => :'EquipmentChassis',
    :'inventory_device_info' => :'InventoryDeviceInfo',
    :'registered_device' => :'RegisteredDevice',
    :'shared_io_module' => :'SharedIoModule'
  }
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



329
330
331
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 329

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



145
146
147
148
149
150
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 145

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

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



153
154
155
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 153

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



139
140
141
142
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 139

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'chassis_id' => :'String',
    :'connection_path' => :'String',
    :'connection_status' => :'String',
    :'description' => :'String',
    :'managing_instance' => :'String',
    :'oper_state' => :'String',
    :'part_number' => :'String',
    :'pid' => :'String',
    :'system_io_controller_id' => :'Integer',
    :'cmc' => :'ManagementControllerRelationship',
    :'equipment_chassis' => :'EquipmentChassisRelationship',
    :'inventory_device_info' => :'InventoryDeviceInfoRelationship',
    :'registered_device' => :'AssetDeviceRegistrationRelationship',
    :'shared_io_module' => :'EquipmentSharedIoModuleRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      chassis_id == o.chassis_id &&
      connection_path == o.connection_path &&
      connection_status == o.connection_status &&
      description == o.description &&
      managing_instance == o.managing_instance &&
      oper_state == o.oper_state &&
      part_number == o.part_number &&
      pid == o.pid &&
      system_io_controller_id == o.system_io_controller_id &&
      cmc == o.cmc &&
      equipment_chassis == o.equipment_chassis &&
      inventory_device_info == o.inventory_device_info &&
      registered_device == o.registered_device &&
      shared_io_module == o.shared_io_module && 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



360
361
362
363
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
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 360

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



431
432
433
434
435
436
437
438
439
440
441
442
443
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 431

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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 336

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


316
317
318
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 316

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



322
323
324
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 322

def hash
  [class_id, object_type, chassis_id, connection_path, connection_status, description, managing_instance, oper_state, part_number, pid, system_io_controller_id, cmc, equipment_chassis, inventory_device_info, registered_device, shared_io_module].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 246

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



407
408
409
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 407

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



413
414
415
416
417
418
419
420
421
422
423
424
425
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 413

def to_hash
  hash = super
  EquipmentSystemIoController.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = EquipmentSystemIoController.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



401
402
403
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 401

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



261
262
263
264
265
266
267
268
269
# File 'lib/intersight_client/models/equipment_system_io_controller.rb', line 261

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