Class: IntersightClient::CloudBaseVolume

Inherits:
VirtualizationBaseVirtualDisk show all
Defined in:
lib/intersight_client/models/cloud_base_volume.rb

Overview

A base Volume definition extended by cloud specific Volumes objects.

Direct Known Subclasses

CloudAwsVolume

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from VirtualizationBaseVirtualDisk

#name, #size

Attributes inherited from VirtualizationBaseSourceDevice

#registered_device

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 159

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

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

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

  if attributes.key?(:'encryption_state')
    self.encryption_state = attributes[:'encryption_state']
  else
    self.encryption_state = 'Automatic'
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#billing_unit ⇒ Object

Returns the value of attribute billing_unit.



25
26
27
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 25

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

def class_id
  @class_id
end

#encryption_state ⇒ Object

Encryption state of this volume.For example ENCRYPTED, NOT ENCRYPTED, etc. * Automatic - Volume encryption state is automatic.Cloud provider takes the decision of when to encrypt the data. * Encrypted - Volume data is encrypted. Can be decrypted only by authorized users. * Not_Encrypted - Volume data is not encrypted.



28
29
30
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 28

def encryption_state
  @encryption_state
end

#identity ⇒ Object

The internally generated identity of this VM. It aids in uniquely identifying the volume object.



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

def identity
  @identity
end

#instance_attachments ⇒ Object

Returns the value of attribute instance_attachments.



33
34
35
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 33

def instance_attachments
  @instance_attachments
end

#iops_info ⇒ Object

Returns the value of attribute iops_info.



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

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

def object_type
  @object_type
end

#region_info ⇒ Object

Returns the value of attribute region_info.



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

def region_info
  @region_info
end

#source_image_id ⇒ Object

Source Image Id used for the volume.



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

def source_image_id
  @source_image_id
end

#state ⇒ Object

The volume state.For example AVAILABLE, IN_USE, DELETED, etc. * UnRecognized - Volume is in unrecognized state. * Pending - Volume is in pending state, due to errors encountered during volume creation. * Bound - Volume is in bound state. * Available - Volume is in available state. * Error - Volume is in error state. * Released - Volume is in released state. * in-use - Volume is in in-use state. * Creating - Volume is in creating state. * Deleting - Volume is in deleting state. * Deleted - Volume is in deleted state.



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

def state
  @state
end

#uuid ⇒ Object

UUID (Universally Unique IDentifier) is a 128-bit value used for unique identification of Volume.



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

def uuid
  @uuid
end

#volume_create_time ⇒ Object

Time when this volume is created.



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

def volume_create_time
  @volume_create_time
end

#volume_tags ⇒ Object

Returns the value of attribute volume_tags.



51
52
53
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 51

def volume_tags
  @volume_tags
end

#volume_type ⇒ Object

Returns the value of attribute volume_type.



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

def volume_type
  @volume_type
end

#zone_info ⇒ Object

Returns the value of attribute zone_info.



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

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



106
107
108
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 106

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)



101
102
103
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 101

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.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 80

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'billing_unit' => :'BillingUnit',
    :'encryption_state' => :'EncryptionState',
    :'identity' => :'Identity',
    :'instance_attachments' => :'InstanceAttachments',
    :'iops_info' => :'IopsInfo',
    :'region_info' => :'RegionInfo',
    :'source_image_id' => :'SourceImageId',
    :'state' => :'State',
    :'uuid' => :'Uuid',
    :'volume_create_time' => :'VolumeCreateTime',
    :'volume_tags' => :'VolumeTags',
    :'volume_type' => :'VolumeType',
    :'zone_info' => :'ZoneInfo'
  }
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



356
357
358
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 356

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



145
146
147
148
149
150
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 145

def self.openapi_all_of
  [
  :'CloudBaseVolumeAllOf',
  :'VirtualizationBaseVirtualDisk'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



153
154
155
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 153

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 132

def self.openapi_nullable
  Set.new([
    :'billing_unit',
    :'instance_attachments',
    :'iops_info',
    :'region_info',
    :'volume_tags',
    :'volume_type',
    :'zone_info'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 111

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'billing_unit' => :'CloudBillingUnit',
    :'encryption_state' => :'String',
    :'identity' => :'String',
    :'instance_attachments' => :'Array<CloudVolumeInstanceAttachment>',
    :'iops_info' => :'CloudVolumeIopsInfo',
    :'region_info' => :'CloudCloudRegion',
    :'source_image_id' => :'String',
    :'state' => :'String',
    :'uuid' => :'String',
    :'volume_create_time' => :'Time',
    :'volume_tags' => :'Array<CloudCloudTag>',
    :'volume_type' => :'CloudVolumeType',
    :'zone_info' => :'CloudAvailabilityZone'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      billing_unit == o.billing_unit &&
      encryption_state == o.encryption_state &&
      identity == o.identity &&
      instance_attachments == o.instance_attachments &&
      iops_info == o.iops_info &&
      region_info == o.region_info &&
      source_image_id == o.source_image_id &&
      state == o.state &&
      uuid == o.uuid &&
      volume_create_time == o.volume_create_time &&
      volume_tags == o.volume_tags &&
      volume_type == o.volume_type &&
      zone_info == o.zone_info && 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



387
388
389
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
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 387

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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 458

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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 363

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


343
344
345
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 343

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



349
350
351
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 349

def hash
  [class_id, object_type, billing_unit, encryption_state, identity, instance_attachments, iops_info, region_info, source_image_id, state, uuid, volume_create_time, volume_tags, volume_type, zone_info].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



250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 250

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



434
435
436
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 434

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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 440

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



428
429
430
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 428

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/intersight_client/models/cloud_base_volume.rb', line 265

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["cloud.AwsVolume"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["cloud.AwsVolume"])
  return false unless object_type_validator.valid?(@object_type)
  encryption_state_validator = EnumAttributeValidator.new('String', ["Automatic", "Encrypted", "Not_Encrypted"])
  return false unless encryption_state_validator.valid?(@encryption_state)
  state_validator = EnumAttributeValidator.new('String', ["UnRecognized", "Pending", "Bound", "Available", "Error", "Released", "in-use", "Creating", "Deleting", "Deleted"])
  return false unless state_validator.valid?(@state)
  true && super
end