Class: IbmCloudPower::VolumeReference

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/models/volume_reference.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeReference

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 220

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::VolumeReference` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `IbmCloudPower::VolumeReference`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aux_volume_nameObject

Auxiliary volume name at storage host level



19
20
21
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 19

def aux_volume_name
  @aux_volume_name
end

#auxiliaryObject

true if volume is auxiliary otherwise false



22
23
24
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 22

def auxiliary
  @auxiliary
end

#boot_volumeObject

Indicates if the volume is the server’s boot volume. Only returned when querying a server’s attached volumes



25
26
27
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 25

def boot_volume
  @boot_volume
end

#bootableObject

Indicates if the volume is boot capable



28
29
30
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 28

def bootable
  @bootable
end

#consistency_group_nameObject

Consistency Group Name if volume is a part of volume group



31
32
33
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 31

def consistency_group_name
  @consistency_group_name
end

#creation_dateObject

Creation Date



34
35
36
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 34

def creation_date
  @creation_date
end

#crnObject

Returns the value of attribute crn.



36
37
38
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 36

def crn
  @crn
end

#delete_on_terminationObject

Indicates if the volume should be deleted when the server terminates. Only returned when querying a server’s attached volumes



39
40
41
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 39

def delete_on_termination
  @delete_on_termination
end

#disk_typeObject

Type of Disk



42
43
44
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 42

def disk_type
  @disk_type
end

#freeze_timeObject

Freeze time of remote copy relationship



45
46
47
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 45

def freeze_time
  @freeze_time
end

#group_idObject

Volume Group ID



48
49
50
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 48

def group_id
  @group_id
end

#hrefObject

Link to Volume resource



51
52
53
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 51

def href
  @href
end

#io_throttle_rateObject

Amount of iops assigned to the volume



54
55
56
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 54

def io_throttle_rate
  @io_throttle_rate
end

#last_update_dateObject

Last Update Date



57
58
59
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 57

def last_update_date
  @last_update_date
end

#master_volume_nameObject

Master volume name at storage host level



60
61
62
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 60

def master_volume_name
  @master_volume_name
end

#mirroring_stateObject

mirroring state for replication enabled volume



63
64
65
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 63

def mirroring_state
  @mirroring_state
end

#nameObject

Volume Name



66
67
68
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 66

def name
  @name
end

#out_of_band_deletedObject

true if volume does not exist on storage controller, as volume has been deleted by deleting its paired volume from the mapped replication site.



69
70
71
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 69

def out_of_band_deleted
  @out_of_band_deleted
end

#primary_roleObject

indicates whether master/aux volume is playing the primary role



72
73
74
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 72

def primary_role
  @primary_role
end

#pvm_instance_idsObject

List of PCloud PVM Instance attached to the volume



75
76
77
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 75

def pvm_instance_ids
  @pvm_instance_ids
end

#replication_enabledObject

True if volume is replication enabled otherwise false



78
79
80
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 78

def replication_enabled
  @replication_enabled
end

#replication_statusObject

shows the replication status of a volume



81
82
83
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 81

def replication_status
  @replication_status
end

#replication_typeObject

type of replication(metro, global)s



84
85
86
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 84

def replication_type
  @replication_type
end

#shareableObject

Indicates if the volume is shareable between VMs



87
88
89
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 87

def shareable
  @shareable
end

#sizeObject

Volume Size



90
91
92
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 90

def size
  @size
end

#stateObject

Volume State



93
94
95
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 93

def state
  @state
end

#user_tagsObject

Returns the value of attribute user_tags.



95
96
97
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 95

def user_tags
  @user_tags
end

#volume_idObject

Volume ID



98
99
100
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 98

def volume_id
  @volume_id
end

#volume_poolObject

Volume pool, name of storage pool where the volume is located



101
102
103
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 101

def volume_pool
  @volume_pool
end

#volume_typeObject

Volume type, name of storage template used to create the volume



104
105
106
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 104

def volume_type
  @volume_type
end

#wwnObject

Volume world wide name



107
108
109
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 107

def wwn
  @wwn
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



169
170
171
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 169

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



132
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
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 132

def self.attribute_map
  {
    :'aux_volume_name' => :'auxVolumeName',
    :'auxiliary' => :'auxiliary',
    :'boot_volume' => :'bootVolume',
    :'bootable' => :'bootable',
    :'consistency_group_name' => :'consistencyGroupName',
    :'creation_date' => :'creationDate',
    :'crn' => :'crn',
    :'delete_on_termination' => :'deleteOnTermination',
    :'disk_type' => :'diskType',
    :'freeze_time' => :'freezeTime',
    :'group_id' => :'groupID',
    :'href' => :'href',
    :'io_throttle_rate' => :'ioThrottleRate',
    :'last_update_date' => :'lastUpdateDate',
    :'master_volume_name' => :'masterVolumeName',
    :'mirroring_state' => :'mirroringState',
    :'name' => :'name',
    :'out_of_band_deleted' => :'outOfBandDeleted',
    :'primary_role' => :'primaryRole',
    :'pvm_instance_ids' => :'pvmInstanceIDs',
    :'replication_enabled' => :'replicationEnabled',
    :'replication_status' => :'replicationStatus',
    :'replication_type' => :'replicationType',
    :'shareable' => :'shareable',
    :'size' => :'size',
    :'state' => :'state',
    :'user_tags' => :'userTags',
    :'volume_id' => :'volumeID',
    :'volume_pool' => :'volumePool',
    :'volume_type' => :'volumeType',
    :'wwn' => :'wwn'
  }
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



493
494
495
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 493

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

.openapi_nullableObject

List of attributes with nullable: true



211
212
213
214
215
216
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 211

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

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 174

def self.openapi_types
  {
    :'aux_volume_name' => :'String',
    :'auxiliary' => :'Boolean',
    :'boot_volume' => :'Boolean',
    :'bootable' => :'Boolean',
    :'consistency_group_name' => :'String',
    :'creation_date' => :'Time',
    :'crn' => :'String',
    :'delete_on_termination' => :'Boolean',
    :'disk_type' => :'String',
    :'freeze_time' => :'Time',
    :'group_id' => :'String',
    :'href' => :'String',
    :'io_throttle_rate' => :'String',
    :'last_update_date' => :'Time',
    :'master_volume_name' => :'String',
    :'mirroring_state' => :'String',
    :'name' => :'String',
    :'out_of_band_deleted' => :'Boolean',
    :'primary_role' => :'String',
    :'pvm_instance_ids' => :'Array<String>',
    :'replication_enabled' => :'Boolean',
    :'replication_status' => :'String',
    :'replication_type' => :'String',
    :'shareable' => :'Boolean',
    :'size' => :'Float',
    :'state' => :'String',
    :'user_tags' => :'Array',
    :'volume_id' => :'String',
    :'volume_pool' => :'String',
    :'volume_type' => :'String',
    :'wwn' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 442

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aux_volume_name == o.aux_volume_name &&
      auxiliary == o.auxiliary &&
      boot_volume == o.boot_volume &&
      bootable == o.bootable &&
      consistency_group_name == o.consistency_group_name &&
      creation_date == o.creation_date &&
      crn == o.crn &&
      delete_on_termination == o.delete_on_termination &&
      disk_type == o.disk_type &&
      freeze_time == o.freeze_time &&
      group_id == o.group_id &&
      href == o.href &&
      io_throttle_rate == o.io_throttle_rate &&
      last_update_date == o.last_update_date &&
      master_volume_name == o.master_volume_name &&
      mirroring_state == o.mirroring_state &&
      name == o.name &&
      out_of_band_deleted == o.out_of_band_deleted &&
      primary_role == o.primary_role &&
      pvm_instance_ids == o.pvm_instance_ids &&
      replication_enabled == o.replication_enabled &&
      replication_status == o.replication_status &&
      replication_type == o.replication_type &&
      shareable == o.shareable &&
      size == o.size &&
      state == o.state &&
      user_tags == o.user_tags &&
      volume_id == o.volume_id &&
      volume_pool == o.volume_pool &&
      volume_type == o.volume_type &&
      wwn == o.wwn
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



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 523

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 = IbmCloudPower.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



594
595
596
597
598
599
600
601
602
603
604
605
606
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 594

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



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 500

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


480
481
482
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 480

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



486
487
488
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 486

def hash
  [aux_volume_name, auxiliary, boot_volume, bootable, consistency_group_name, creation_date, crn, delete_on_termination, disk_type, freeze_time, group_id, href, io_throttle_rate, last_update_date, master_volume_name, mirroring_state, name, out_of_band_deleted, primary_role, pvm_instance_ids, replication_enabled, replication_status, replication_type, shareable, size, state, user_tags, volume_id, volume_pool, volume_type, wwn].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
398
399
400
401
402
403
404
405
406
407
408
409
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 362

def list_invalid_properties
  invalid_properties = Array.new
  if @bootable.nil?
    invalid_properties.push('invalid value for "bootable", bootable cannot be nil.')
  end

  if @creation_date.nil?
    invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.')
  end

  if @disk_type.nil?
    invalid_properties.push('invalid value for "disk_type", disk_type cannot be nil.')
  end

  if @href.nil?
    invalid_properties.push('invalid value for "href", href cannot be nil.')
  end

  if @last_update_date.nil?
    invalid_properties.push('invalid value for "last_update_date", last_update_date cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @shareable.nil?
    invalid_properties.push('invalid value for "shareable", shareable cannot be nil.')
  end

  if @size.nil?
    invalid_properties.push('invalid value for "size", size cannot be nil.')
  end

  if @state.nil?
    invalid_properties.push('invalid value for "state", state cannot be nil.')
  end

  if @volume_id.nil?
    invalid_properties.push('invalid value for "volume_id", volume_id cannot be nil.')
  end

  if @wwn.nil?
    invalid_properties.push('invalid value for "wwn", wwn 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



570
571
572
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 570

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



576
577
578
579
580
581
582
583
584
585
586
587
588
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 576

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



564
565
566
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 564

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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/ibm_cloud_power/models/volume_reference.rb', line 413

def valid?
  return false if @bootable.nil?
  return false if @creation_date.nil?
  return false if @disk_type.nil?
  return false if @href.nil?
  return false if @last_update_date.nil?
  return false if @name.nil?
  primary_role_validator = EnumAttributeValidator.new('String', ["master", "aux"])
  return false unless primary_role_validator.valid?(@primary_role)
  return false if @shareable.nil?
  return false if @size.nil?
  return false if @state.nil?
  return false if @volume_id.nil?
  return false if @wwn.nil?
  true
end