Class: IbmCloudPower::Volume

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Volume

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
167
168
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 102

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

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

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

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

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

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

  if attributes.key?(:'boot_volume')
    self.boot_volume = attributes[:'boot_volume']
  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?(:'wwn')
    self.wwn = attributes[:'wwn']
  end

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

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

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

Instance Attribute Details

#boot_volume ⇒ Object

Indicates if the volume is the server’s boot volume



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

def boot_volume
  @boot_volume
end

#bootable ⇒ Object

Indicates if the volume is boot capable



33
34
35
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 33

def bootable
  @bootable
end

#creation_date ⇒ Object

Creation Date



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

def creation_date
  @creation_date
end

#delete_on_termination ⇒ Object

Indicates if the volume should be deleted when the server terminates



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

def delete_on_termination
  @delete_on_termination
end

#disk_type ⇒ Object

Type of Disk



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

def disk_type
  @disk_type
end

#last_update_date ⇒ Object

Last Update Date



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

def last_update_date
  @last_update_date
end

#name ⇒ Object

Volume Name



21
22
23
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 21

def name
  @name
end

#pvm_instance_i_ds ⇒ Object

List of PCloud PVM Instance attached to the volume



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

def pvm_instance_i_ds
  @pvm_instance_i_ds
end

#shareable ⇒ Object

Indicates if the volume is shareable between VMs



30
31
32
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 30

def shareable
  @shareable
end

#size ⇒ Object

Volume Size



27
28
29
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 27

def size
  @size
end

#state ⇒ Object

Volume State



24
25
26
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 24

def state
  @state
end

#volume_id ⇒ Object

Volume ID



18
19
20
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 18

def volume_id
  @volume_id
end

#wwn ⇒ Object

Volume world wide name



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

def wwn
  @wwn
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 57

def self.attribute_map
  {
    :'volume_id' => :'volumeID',
    :'name' => :'name',
    :'state' => :'state',
    :'size' => :'size',
    :'shareable' => :'shareable',
    :'bootable' => :'bootable',
    :'boot_volume' => :'bootVolume',
    :'delete_on_termination' => :'deleteOnTermination',
    :'disk_type' => :'diskType',
    :'wwn' => :'wwn',
    :'creation_date' => :'creationDate',
    :'last_update_date' => :'lastUpdateDate',
    :'pvm_instance_i_ds' => :'pvmInstanceIDs'
  }
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



243
244
245
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 243

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 76

def self.openapi_types
  {
    :'volume_id' => :'String',
    :'name' => :'String',
    :'state' => :'String',
    :'size' => :'Float',
    :'shareable' => :'Boolean',
    :'bootable' => :'Boolean',
    :'boot_volume' => :'Boolean',
    :'delete_on_termination' => :'Boolean',
    :'disk_type' => :'String',
    :'wwn' => :'String',
    :'creation_date' => :'DateTime',
    :'last_update_date' => :'DateTime',
    :'pvm_instance_i_ds' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      volume_id == o.volume_id &&
      name == o.name &&
      state == o.state &&
      size == o.size &&
      shareable == o.shareable &&
      bootable == o.bootable &&
      boot_volume == o.boot_volume &&
      delete_on_termination == o.delete_on_termination &&
      disk_type == o.disk_type &&
      wwn == o.wwn &&
      creation_date == o.creation_date &&
      last_update_date == o.last_update_date &&
      pvm_instance_i_ds == o.pvm_instance_i_ds
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



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

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    IbmCloudPower.const_get(type).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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 342

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 250

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 236

def hash
  [volume_id, name, state, size, shareable, bootable, boot_volume, delete_on_termination, disk_type, wwn, creation_date, last_update_date, pvm_instance_i_ds].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



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/ibm_cloud_power/models/volume.rb', line 172

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

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

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

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

  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



318
319
320
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 324

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



312
313
314
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 312

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



199
200
201
202
203
204
205
206
 
# File 'lib/ibm_cloud_power/models/volume.rb', line 199

def valid?
  return false if @volume_id.nil?
  return false if @name.nil?
  return false if @size.nil?
  return false if @creation_date.nil?
  return false if @last_update_date.nil?
  true
end