Class: IntersightClient::EquipmentIdentity

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/equipment_identity.rb

Overview

An Abstract Identity object that uniquely represents an equipment.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 133

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

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

  if attributes.key?(:'admin_action')
    self.admin_action = attributes[:'admin_action']
  else
    self.admin_action = 'None'
  end

  if attributes.key?(:'admin_action_state')
    self.admin_action_state = attributes[:'admin_action_state']
  else
    self.admin_action_state = 'None'
  end

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

  if attributes.key?(:'lifecycle')
    self.lifecycle = attributes[:'lifecycle']
  else
    self.lifecycle = 'None'
  end

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

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

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

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

Instance Attribute Details

#admin_action ⇒ Object

Updated by UI/API to trigger specific chassis action type. * None - No operation value for maintenance actions on an equipment. * Decommission - Decommission the equipment and temporarily remove it from being managed by Intersight. * Recommission - Recommission the equipment. * Reack - Reacknowledge the equipment and discover it again. * Remove - Remove the equipment permanently from Intersight management. * Replace - Replace the equipment with the other one.



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

def admin_action
  @admin_action
end

#admin_action_state ⇒ Object

The state of Maintenance Action performed. This will have three states. Applying - Action is in progress. Applied - Action is completed and applied. Failed - Action has failed. * None - Nil value when no action has been triggered by the user. * Applied - User configured settings are in applied state. * Applying - User settings are being applied on the target server. * Failed - User configured settings could not be applied.



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

def admin_action_state
  @admin_action_state
end

#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. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def class_id
  @class_id
end

#identifier ⇒ Object

Numeric Identifier assigned by the management system to the equipment.



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

def identifier
  @identifier
end

#lifecycle ⇒ Object

The equipment’s lifecycle status. * None - Default state of an equipment. This should be an initial state when no state is defined for an equipment. * Active - Default Lifecycle State for a physical entity. * Decommissioned - Decommission Lifecycle state. * DecommissionInProgress - Decommission Inprogress Lifecycle state. * RecommissionInProgress - Recommission Inprogress Lifecycle state. * OperationFailed - Failed Operation Lifecycle state. * ReackInProgress - ReackInProgress Lifecycle state. * RemoveInProgress - RemoveInProgress Lifecycle state. * Discovered - Discovered Lifecycle state. * DiscoveryInProgress - DiscoveryInProgress Lifecycle state. * DiscoveryFailed - DiscoveryFailed Lifecycle state. * FirmwareUpgradeInProgress - Firmware upgrade is in progress on given physical entity. * BladeMigrationInProgress - Server slot migration is in progress on given physical entity. * Inactive - Inactive Lifecycle state. * ReplaceInProgress - ReplaceInProgress Lifecycle state. * SlotMismatch - The blade server is detected in a different chassis/slot than it was previously.



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

def lifecycle
  @lifecycle
end

#model ⇒ Object

The vendor provided model name for the equipment.



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

def model
  @model
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property. The enum values provides the list of concrete types that can be instantiated from this abstract type.



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

def object_type
  @object_type
end

#registered_device ⇒ Object

Returns the value of attribute registered_device.



46
47
48
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 46

def registered_device
  @registered_device
end

#serial ⇒ Object

The serial number of the equipment.



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

def serial
  @serial
end

#vendor ⇒ Object

The manufacturer of the equipment.



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

def vendor
  @vendor
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)



92
93
94
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 92

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)



87
88
89
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 87

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.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 71

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'admin_action' => :'AdminAction',
    :'admin_action_state' => :'AdminActionState',
    :'identifier' => :'Identifier',
    :'lifecycle' => :'Lifecycle',
    :'model' => :'Model',
    :'serial' => :'Serial',
    :'vendor' => :'Vendor',
    :'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



311
312
313
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 311

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



119
120
121
122
123
124
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 119

def self.openapi_all_of
  [
  :'EquipmentIdentityAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



127
128
129
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 127

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 97

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'admin_action' => :'String',
    :'admin_action_state' => :'String',
    :'identifier' => :'Integer',
    :'lifecycle' => :'String',
    :'model' => :'String',
    :'serial' => :'String',
    :'vendor' => :'String',
    :'registered_device' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      admin_action == o.admin_action &&
      admin_action_state == o.admin_action_state &&
      identifier == o.identifier &&
      lifecycle == o.lifecycle &&
      model == o.model &&
      serial == o.serial &&
      vendor == o.vendor &&
      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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 342

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



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

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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 318

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


298
299
300
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 304

def hash
  [class_id, object_type, admin_action, admin_action_state, identifier, lifecycle, model, serial, vendor, 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



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 198

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



389
390
391
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 389

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 395

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



383
384
385
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 383

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/intersight_client/models/equipment_identity.rb', line 213

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["compute.BladeIdentity", "compute.RackUnitIdentity", "equipment.ChassisIdentity", "equipment.FexIdentity", "fabric.ElementIdentity"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["compute.BladeIdentity", "compute.RackUnitIdentity", "equipment.ChassisIdentity", "equipment.FexIdentity", "fabric.ElementIdentity"])
  return false unless object_type_validator.valid?(@object_type)
  admin_action_validator = EnumAttributeValidator.new('String', ["None", "Decommission", "Recommission", "Reack", "Remove", "Replace"])
  return false unless admin_action_validator.valid?(@admin_action)
  admin_action_state_validator = EnumAttributeValidator.new('String', ["None", "Applied", "Applying", "Failed"])
  return false unless admin_action_state_validator.valid?(@admin_action_state)
  lifecycle_validator = EnumAttributeValidator.new('String', ["None", "Active", "Decommissioned", "DecommissionInProgress", "RecommissionInProgress", "OperationFailed", "ReackInProgress", "RemoveInProgress", "Discovered", "DiscoveryInProgress", "DiscoveryFailed", "FirmwareUpgradeInProgress", "BladeMigrationInProgress", "Inactive", "ReplaceInProgress", "SlotMismatch"])
  return false unless lifecycle_validator.valid?(@lifecycle)
  true && super
end