Class: IntersightClient::HyperflexVolume

Inherits:
StorageBaseVolume show all
Defined in:
lib/intersight_client/models/hyperflex_volume.rb

Overview

A HyperFlex Volume entity.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from StorageBaseVolume

#description, #naa_id, #name, #size, #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 = {}) ⇒ HyperflexVolume

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
247
248
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 161

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'volume_access_mode')
    self.volume_access_mode = attributes[:'volume_access_mode']
  else
    self.volume_access_mode = 'ReadWriteOnce'
  end

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

  if attributes.key?(:'volume_mode')
    self.volume_mode = attributes[:'volume_mode']
  else
    self.volume_mode = 'Block'
  end

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

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

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

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

Instance Attribute Details

#capacity ⇒ Object

Provisioned Capacity of the volume in bytes.



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

def capacity
  @capacity
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.



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

def class_id
  @class_id
end

#client_id ⇒ Object

Client (tenant) ID to which the volume belongs.



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

def client_id
  @client_id
end

#cluster ⇒ Object

Returns the value of attribute cluster.



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

def cluster
  @cluster
end

#hxap_virtual_disk ⇒ Object

Returns the value of attribute hxap_virtual_disk.



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

def hxap_virtual_disk
  @hxap_virtual_disk
end

#kubernetes_cluster_name ⇒ Object

The name of the kubernetes cluster to which the volume is associated.



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

def kubernetes_cluster_name
  @kubernetes_cluster_name
end

#last_modified_time ⇒ Object

Last modified time as UTC of the volume.



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

def last_modified_time
  @last_modified_time
end

#lun_uuid ⇒ Object

UUID of LUN associated with the volume.



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

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

def object_type
  @object_type
end

#serial_number ⇒ Object

Serial number of the volume.



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

def serial_number
  @serial_number
end

#storage_container ⇒ Object

Returns the value of attribute storage_container.



62
63
64
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 62

def storage_container
  @storage_container
end

#uuid ⇒ Object

The unique identifier for this volume.



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

def uuid
  @uuid
end

#volume_access_mode ⇒ Object

Access Mode of the volume. * ‘ReadWriteOnce` - Read write permisisons to a Virtual disk by a single virtual machine. * `ReadWriteMany` - Read write permisisons to a Virtual disk by multiple virtual machines. * `ReadOnlyMany` - Read only permisisons to a Virtual disk by multiple virtual machines. * “ - Unknown disk access mode.



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

def volume_access_mode
  @volume_access_mode
end

#volume_create_time ⇒ Object

Volume creation time in UTC.



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

def volume_create_time
  @volume_create_time
end

#volume_mode ⇒ Object

The mode of the HyperFlex volume. * ‘Block` - It is a Block virtual disk. * `Filesystem` - It is a File system virtual disk. * “ - Disk mode is either unknown or not supported.



53
54
55
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 53

def volume_mode
  @volume_mode
end

#volume_type ⇒ Object

The type of the HyperFlex volume.



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

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



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

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)



109
110
111
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 109

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.



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

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'capacity' => :'Capacity',
    :'client_id' => :'ClientId',
    :'kubernetes_cluster_name' => :'KubernetesClusterName',
    :'last_modified_time' => :'LastModifiedTime',
    :'lun_uuid' => :'LunUuid',
    :'serial_number' => :'SerialNumber',
    :'uuid' => :'Uuid',
    :'volume_access_mode' => :'VolumeAccessMode',
    :'volume_create_time' => :'VolumeCreateTime',
    :'volume_mode' => :'VolumeMode',
    :'volume_type' => :'VolumeType',
    :'cluster' => :'Cluster',
    :'hxap_virtual_disk' => :'HxapVirtualDisk',
    :'storage_container' => :'StorageContainer'
  }
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



359
360
361
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 359

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/hyperflex_volume.rb', line 147

def self.openapi_all_of
  [
  :'HyperflexVolumeAllOf',
  :'StorageBaseVolume'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



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

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'capacity' => :'Integer',
    :'client_id' => :'String',
    :'kubernetes_cluster_name' => :'String',
    :'last_modified_time' => :'Time',
    :'lun_uuid' => :'String',
    :'serial_number' => :'String',
    :'uuid' => :'String',
    :'volume_access_mode' => :'String',
    :'volume_create_time' => :'Time',
    :'volume_mode' => :'String',
    :'volume_type' => :'String',
    :'cluster' => :'HyperflexClusterRelationship',
    :'hxap_virtual_disk' => :'HyperflexHxapVirtualDiskRelationship',
    :'storage_container' => :'HyperflexStorageContainerRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 323

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      capacity == o.capacity &&
      client_id == o.client_id &&
      kubernetes_cluster_name == o.kubernetes_cluster_name &&
      last_modified_time == o.last_modified_time &&
      lun_uuid == o.lun_uuid &&
      serial_number == o.serial_number &&
      uuid == o.uuid &&
      volume_access_mode == o.volume_access_mode &&
      volume_create_time == o.volume_create_time &&
      volume_mode == o.volume_mode &&
      volume_type == o.volume_type &&
      cluster == o.cluster &&
      hxap_virtual_disk == o.hxap_virtual_disk &&
      storage_container == o.storage_container && 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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 390

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



461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 461

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 366

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


346
347
348
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 346

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



352
353
354
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 352

def hash
  [class_id, object_type, capacity, client_id, kubernetes_cluster_name, last_modified_time, lun_uuid, serial_number, uuid, volume_access_mode, volume_create_time, volume_mode, volume_type, cluster, hxap_virtual_disk, storage_container].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



252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 252

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



437
438
439
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 437

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



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 443

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



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

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/intersight_client/models/hyperflex_volume.rb', line 267

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["hyperflex.Volume"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["hyperflex.Volume"])
  return false unless object_type_validator.valid?(@object_type)
  volume_access_mode_validator = EnumAttributeValidator.new('String', ["ReadWriteOnce", "ReadWriteMany", "ReadOnlyMany", ""])
  return false unless volume_access_mode_validator.valid?(@volume_access_mode)
  volume_mode_validator = EnumAttributeValidator.new('String', ["Block", "Filesystem", ""])
  return false unless volume_mode_validator.valid?(@volume_mode)
  true && super
end