Class: IntersightClient::HyperflexStorageContainer

Inherits:
StorageBaseStorageContainer show all
Defined in:
lib/intersight_client/models/hyperflex_storage_container.rb

Overview

A storage container (datastore) entity.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from StorageBaseStorageContainer

#created_time, #name, #storage_utilization

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 179

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

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

  if attributes.key?(:'accessibility_summary')
    self.accessibility_summary = attributes[:'accessibility_summary']
  else
    self.accessibility_summary = 'NOT_APPLICABLE'
  end

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

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

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

  if attributes.key?(:'kind')
    self.kind = attributes[:'kind']
  else
    self.kind = 'UNKNOWN'
  end

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

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

  if attributes.key?(:'mount_status')
    self.mount_status = attributes[:'mount_status']
  else
    self.mount_status = 'NOT_APPLICABLE'
  end

  if attributes.key?(:'mount_summary')
    self.mount_summary = attributes[:'mount_summary']
  else
    self.mount_summary = 'NOT_APPLICABLE'
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#accessibility_summaryObject

Storage container accessibility summary. * ‘NOT_APPLICABLE` - The HyperFlex storage container accessibility summary is not applicable. * `ACCESSIBLE` - The HyperFlex storage container is accessible. * `NOT_ACCESSIBLE` - The HyperFlex storage container is not accessible. * `PARTIALLY_ACCESSIBLE` - The HyperFlex storage container is partially accessible.



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

def accessibility_summary
  @accessibility_summary
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/hyperflex_storage_container.rb', line 20

def class_id
  @class_id
end

#clusterObject

Returns the value of attribute cluster.



69
70
71
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 69

def cluster
  @cluster
end

#data_block_sizeObject

Storage container data block size in bytes.



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

def data_block_size
  @data_block_size
end

#host_mount_statusObject

Returns the value of attribute host_mount_status.



31
32
33
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 31

def host_mount_status
  @host_mount_status
end

#in_useObject

Indicates whether the storage container has volumes.



34
35
36
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 34

def in_use
  @in_use
end

#kindObject

Indicates whether the storage container was user-created, or system-created. * ‘UNKNOWN` - The storage container creator is unknown. * `USER_CREATED` - The storage container was created by a user action. * `INTERNAL` - The storage container was created by the system.



37
38
39
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 37

def kind
  @kind
end

#last_access_timeObject

Storage container’s last access time.



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

def last_access_time
  @last_access_time
end

#last_modified_timeObject

Storage container’s last modified time.



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

def last_modified_time
  @last_modified_time
end

#mount_statusObject

Storage container mount status. Applicable only for NFS type. * ‘NOT_APPLICABLE` - The HyperFlex storage container mount status is not applicable. * `NORMAL` - The HyperFlex storage container mount status is normal. * `ALERT` - The HyperFlex storage container mount status is alert. * `FAILED` - The HyperFlex storage container mount status is failed.



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

def mount_status
  @mount_status
end

#mount_summaryObject

Storage container mount summary. Applicable only for NFS type. * ‘NOT_APPLICABLE` - The mount summary is not applicable for this HyperFlex storage container. * `MOUNTED` - The HyperFlex storage container is mounted. * `UNMOUNTED` - The HyperFlex storage container is unmounted. * `MOUNT_FAILURE` - The HyperFlex storage container mount summary is failure. * `UNMOUNT_FAILURE` - The HyperFlex storage container unmount summary is failure.



49
50
51
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 49

def mount_summary
  @mount_summary
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/hyperflex_storage_container.rb', line 23

def object_type
  @object_type
end

#provisioned_capacityObject

Provisioned capacity of the storage container in bytes.



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

def provisioned_capacity
  @provisioned_capacity
end

#provisioned_volume_capacity_utilizationObject

Provisioned capacity utilization of all volumes associated with the storage container.



55
56
57
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 55

def provisioned_volume_capacity_utilization
  @provisioned_volume_capacity_utilization
end

#typeObject

Storage container type (SMB/NFS/iSCSI). * ‘NFS` - Storage container created/accesed through NFS protocol. * `SMB` - Storage container created/accessed through SMB protocol. * `iSCSI` - Storage container created/accessed through iSCSI protocol.



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

def type
  @type
end

#un_compressed_used_bytesObject

Uncompressed bytes on storage container.



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

def un_compressed_used_bytes
  @un_compressed_used_bytes
end

#uuidObject

UUID of the datastore/storage container.



64
65
66
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 64

def uuid
  @uuid
end

#volume_countObject

Number of volumes associated with the storage container.



67
68
69
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 67

def volume_count
  @volume_count
end

#volumesObject

An array of relationships to hyperflexVolume resources.



72
73
74
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 72

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



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

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)



122
123
124
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 122

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

.attribute_mapObject

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 97

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'accessibility_summary' => :'AccessibilitySummary',
    :'data_block_size' => :'DataBlockSize',
    :'host_mount_status' => :'HostMountStatus',
    :'in_use' => :'InUse',
    :'kind' => :'Kind',
    :'last_access_time' => :'LastAccessTime',
    :'last_modified_time' => :'LastModifiedTime',
    :'mount_status' => :'MountStatus',
    :'mount_summary' => :'MountSummary',
    :'provisioned_capacity' => :'ProvisionedCapacity',
    :'provisioned_volume_capacity_utilization' => :'ProvisionedVolumeCapacityUtilization',
    :'type' => :'Type',
    :'un_compressed_used_bytes' => :'UnCompressedUsedBytes',
    :'uuid' => :'Uuid',
    :'volume_count' => :'VolumeCount',
    :'cluster' => :'Cluster',
    :'volumes' => :'Volumes'
  }
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



438
439
440
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 438

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



165
166
167
168
169
170
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 165

def self.openapi_all_of
  [
  :'HyperflexStorageContainerAllOf',
  :'StorageBaseStorageContainer'
  ]
end

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



173
174
175
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 173

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullableObject

List of attributes with nullable: true



157
158
159
160
161
162
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 157

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

.openapi_typesObject

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 132

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'accessibility_summary' => :'String',
    :'data_block_size' => :'Integer',
    :'host_mount_status' => :'Array<StorageStorageContainerHostMountStatus>',
    :'in_use' => :'Boolean',
    :'kind' => :'String',
    :'last_access_time' => :'Time',
    :'last_modified_time' => :'Time',
    :'mount_status' => :'String',
    :'mount_summary' => :'String',
    :'provisioned_capacity' => :'Integer',
    :'provisioned_volume_capacity_utilization' => :'Float',
    :'type' => :'String',
    :'un_compressed_used_bytes' => :'Integer',
    :'uuid' => :'String',
    :'volume_count' => :'Integer',
    :'cluster' => :'HyperflexClusterRelationship',
    :'volumes' => :'Array<HyperflexVolumeRelationship>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 399

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      accessibility_summary == o.accessibility_summary &&
      data_block_size == o.data_block_size &&
      host_mount_status == o.host_mount_status &&
      in_use == o.in_use &&
      kind == o.kind &&
      last_access_time == o.last_access_time &&
      last_modified_time == o.last_modified_time &&
      mount_status == o.mount_status &&
      mount_summary == o.mount_summary &&
      provisioned_capacity == o.provisioned_capacity &&
      provisioned_volume_capacity_utilization == o.provisioned_volume_capacity_utilization &&
      type == o.type &&
      un_compressed_used_bytes == o.un_compressed_used_bytes &&
      uuid == o.uuid &&
      volume_count == o.volume_count &&
      cluster == o.cluster &&
      volumes == o.volumes && 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



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 469

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



540
541
542
543
544
545
546
547
548
549
550
551
552
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 540

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



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 445

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


425
426
427
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 425

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



431
432
433
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 431

def hash
  [class_id, object_type, accessibility_summary, data_block_size, host_mount_status, in_use, kind, last_access_time, last_modified_time, mount_status, mount_summary, provisioned_capacity, provisioned_volume_capacity_utilization, type, un_compressed_used_bytes, uuid, volume_count, cluster, volumes].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 292

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



516
517
518
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 516

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



522
523
524
525
526
527
528
529
530
531
532
533
534
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 522

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



510
511
512
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 510

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/intersight_client/models/hyperflex_storage_container.rb', line 307

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.StorageContainer"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.StorageContainer"])
  return false unless object_type_validator.valid?(@object_type)
  accessibility_summary_validator = EnumAttributeValidator.new('String', ["NOT_APPLICABLE", "ACCESSIBLE", "NOT_ACCESSIBLE", "PARTIALLY_ACCESSIBLE"])
  return false unless accessibility_summary_validator.valid?(@accessibility_summary)
  kind_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "USER_CREATED", "INTERNAL"])
  return false unless kind_validator.valid?(@kind)
  mount_status_validator = EnumAttributeValidator.new('String', ["NOT_APPLICABLE", "NORMAL", "ALERT", "FAILED"])
  return false unless mount_status_validator.valid?(@mount_status)
  mount_summary_validator = EnumAttributeValidator.new('String', ["NOT_APPLICABLE", "MOUNTED", "UNMOUNTED", "MOUNT_FAILURE", "UNMOUNT_FAILURE"])
  return false unless mount_summary_validator.valid?(@mount_summary)
  type_validator = EnumAttributeValidator.new('String', ["NFS", "SMB", "iSCSI"])
  return false unless type_validator.valid?(@type)
  true && super
end