Class: IntersightClient::StorageBaseArrayDisk

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

Overview

Common attributes of a storage array disk.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
195
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 134

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

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

  if attributes.key?(:'protocol')
    self.protocol = attributes[:'protocol']
  else
    self.protocol = 'Unknown'
  end

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'Unknown'
  end

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'Unknown'
  end

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

Instance Attribute Details

#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. 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/storage_base_array_disk.rb', line 20

def class_id
  @class_id
end

#nameObject

Disk name available in storage array.



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

def name
  @name
end

#object_typeObject

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

def object_type
  @object_type
end

#part_numberObject

Storage disk part number.



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

def part_number
  @part_number
end

#protocolObject

Storage protocol used in disk for communication. Possible values are SAS, SATA and NVMe. * ‘Unknown` - Disk protocol is unknown. * `SAS` - Serial Attached SCSI protocol (SAS) used in disk. * `NVMe` - Non-volatile memory express (NVMe) protocol used in disk. * `SATA` - Serial Advanced Technology Attachment (SATA) used in disk.



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

def protocol
  @protocol
end

#speedObject

Disk speed for read or write operation measured in rpm.



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

def speed
  @speed
end

#statusObject

Storage disk health status. * ‘Unknown` - Component status is not available. * `Ok` - Component is healthy and no issues found. * `Degraded` - Functioning, but not at full capability due to a non-fatal failure. * `Critical` - Not functioning or requiring immediate attention. * `Offline` - Component is installed, but powered off. * `Identifying` - Component is in initialization process. * `NotAvailable` - Component is not installed or not available. * `Updating` - Software update is in progress. * `Unrecognized` - Component is not recognized. It may be because the component is not installed properly or it is not supported.



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

def status
  @status
end

#storage_utilizationObject

Returns the value of attribute storage_utilization.



40
41
42
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 40

def storage_utilization
  @storage_utilization
end

#typeObject

Storage disk type - it can be SSD, HDD, NVRAM. * ‘Unknown` - Default unknown disk type. * `SSD` - Storage disk with Solid state disk. * `HDD` - Storage disk with Hard disk drive. * `NVRAM` - Storage disk with Non-volatile random-access memory type. * `SATA` - Disk drive implementation with Serial Advanced Technology Attachment (SATA). * `BSAS` - Bridged SAS-SATA disks with added hardware to enable them to be plugged into a SAS-connected storage shelf. * `FC` - Storage disk with Fiber Channel. * `FSAS` - Near Line SAS. NL-SAS drives are enterprise SATA drives with a SAS interface, head, media, androtational speed of traditional enterprise-class SATA drives with the fully capable SAS interfacetypical for classic SAS drives. * `LUN` - Logical Unit Number refers to a logical disk. * `MSATA` - SATA disk in multi-disk carrier storage shelf. * `SAS` - Storage disk with serial attached SCSI. * `VMDISK` - Virtual machine Data Disk.



43
44
45
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 43

def type
  @type
end

#versionObject

Storage disk version number.



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

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



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

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)



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

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

.attribute_mapObject

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/storage_base_array_disk.rb', line 71

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'name' => :'Name',
    :'part_number' => :'PartNumber',
    :'protocol' => :'Protocol',
    :'speed' => :'Speed',
    :'status' => :'Status',
    :'storage_utilization' => :'StorageUtilization',
    :'type' => :'Type',
    :'version' => :'Version'
  }
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



312
313
314
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 312

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



128
129
130
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 128

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



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

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'name' => :'String',
    :'part_number' => :'String',
    :'protocol' => :'String',
    :'speed' => :'Integer',
    :'status' => :'String',
    :'storage_utilization' => :'StorageBaseCapacity',
    :'type' => :'String',
    :'version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      name == o.name &&
      part_number == o.part_number &&
      protocol == o.protocol &&
      speed == o.speed &&
      status == o.status &&
      storage_utilization == o.storage_utilization &&
      type == o.type &&
      version == o.version && 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



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
380
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 343

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



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

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



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

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


299
300
301
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 299

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



305
306
307
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 305

def hash
  [class_id, object_type, name, part_number, protocol, speed, status, storage_utilization, type, version].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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



390
391
392
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 390

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



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

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



384
385
386
# File 'lib/intersight_client/models/storage_base_array_disk.rb', line 384

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



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

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.PureDisk"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.PureDisk"])
  return false unless object_type_validator.valid?(@object_type)
  protocol_validator = EnumAttributeValidator.new('String', ["Unknown", "SAS", "NVMe", "SATA"])
  return false unless protocol_validator.valid?(@protocol)
  status_validator = EnumAttributeValidator.new('String', ["Unknown", "Ok", "Degraded", "Critical", "Offline", "Identifying", "NotAvailable", "Updating", "Unrecognized"])
  return false unless status_validator.valid?(@status)
  type_validator = EnumAttributeValidator.new('String', ["Unknown", "SSD", "HDD", "NVRAM", "SATA", "BSAS", "FC", "FSAS", "LUN", "MSATA", "SAS", "VMDISK"])
  return false unless type_validator.valid?(@type)
  true && super
end