Class: LinodeOpenapiClient::Volume1

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/volume1.rb

Overview

A Block Storage Volume associated with your Account.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Volume1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

Read-only When this Volume was created.



35
36
37
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 35

def created
  @created
end

#filesystem_path ⇒ Object

Read-only The full filesystem path for the Volume based on the Volume’s label. Path is /dev/disk/by-id/scsi-0Linode_Volume_ + Volume label.



23
24
25
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 23

def filesystem_path
  @filesystem_path
end

#hardware_type ⇒ Object

Read-only The storage type of this Volume.



50
51
52
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 50

def hardware_type
  @hardware_type
end

#id ⇒ Object

Read-only The unique ID of this Volume.



20
21
22
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 20

def id
  @id
end

#label ⇒ Object

__Filterable__ The Volume’s label is for display purposes only.



47
48
49
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 47

def label
  @label
end

#linode_id ⇒ Object

If a Volume is attached to a specific Linode, the ID of that Linode will be displayed here.



44
45
46
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 44

def linode_id
  @linode_id
end

#linode_label ⇒ Object

Read-only If a Volume is attached to a specific Linode, the label of that Linode will be displayed here.



32
33
34
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 32

def linode_label
  @linode_label
end

#region ⇒ Object

Read-only The unique ID of this Region.



38
39
40
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 38

def region
  @region
end

#size ⇒ Object

The Volume’s size, in GiB.



29
30
31
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 29

def size
  @size
end

#status ⇒ Object

Read-only The current status of the volume. Can be one of: - ‘creating` - the Volume is being created and is not yet available for use. - `active` - the Volume is online and available for use. - `resizing` - the Volume is in the process of upgrading its current capacity.



41
42
43
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 41

def status
  @status
end

#tags ⇒ Object

__Filterable__ An array of Tags applied to this object. Tags are for organizational purposes only.



26
27
28
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 26

def tags
  @tags
end

#updated ⇒ Object

Read-only When this Volume was last updated.



53
54
55
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 53

def updated
  @updated
end

Class Method Details

._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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 347

def self._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 = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'filesystem_path' => :'filesystem_path',
    :'tags' => :'tags',
    :'size' => :'size',
    :'linode_label' => :'linode_label',
    :'created' => :'created',
    :'region' => :'region',
    :'status' => :'status',
    :'linode_id' => :'linode_id',
    :'label' => :'label',
    :'hardware_type' => :'hardware_type',
    :'updated' => :'updated'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
124
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 119

def self.openapi_nullable
  Set.new([
    :'linode_label',
    :'linode_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 101

def self.openapi_types
  {
    :'id' => :'Integer',
    :'filesystem_path' => :'String',
    :'tags' => :'Array<String>',
    :'size' => :'Integer',
    :'linode_label' => :'String',
    :'created' => :'Time',
    :'region' => :'String',
    :'status' => :'String',
    :'linode_id' => :'Integer',
    :'label' => :'String',
    :'hardware_type' => :'String',
    :'updated' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      filesystem_path == o.filesystem_path &&
      tags == o.tags &&
      size == o.size &&
      linode_label == o.linode_label &&
      created == o.created &&
      region == o.region &&
      status == o.status &&
      linode_id == o.linode_id &&
      label == o.label &&
      hardware_type == o.hardware_type &&
      updated == o.updated
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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 418

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


310
311
312
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 316

def hash
  [id, filesystem_path, tags, size, linode_label, created, region, status, linode_id, label, hardware_type, updated].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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 194

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@size.nil? && @size > 10240
    invalid_properties.push('invalid value for "size", must be smaller than or equal to 10240.')
  end

  if !@label.nil? && @label.to_s.length > 32
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 32.')
  end

  if !@label.nil? && @label.to_s.length < 1
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$/)
  if !@label.nil? && @label !~ pattern
    invalid_properties.push("invalid value for \"label\", must conform to the pattern #{pattern}.")
  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



394
395
396
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 394

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 400

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



388
389
390
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 388

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



219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/linode_openapi_client/models/volume1.rb', line 219

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@size.nil? && @size > 10240
  status_validator = EnumAttributeValidator.new('String', ["creating", "active", "resizing"])
  return false unless status_validator.valid?(@status)
  return false if !@label.nil? && @label.to_s.length > 32
  return false if !@label.nil? && @label.to_s.length < 1
  return false if !@label.nil? && @label !~ Regexp.new(/^[a-zA-Z]((?!--|__)[a-zA-Z0-9-_])+$/)
  hardware_type_validator = EnumAttributeValidator.new('String', ["hdd", "nvme"])
  return false unless hardware_type_validator.valid?(@hardware_type)
  true
end