Class: LinstorClient::StoragePool

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-linstor-client/models/storage_pool.rb

Overview

Contains information about a storage pool. If state is Error check the storage pool object path for detailed error description: /v1/nodes/nodename/storage-pools/poolname

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StoragePool

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
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
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 96

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#free_capacity ⇒ Object

Kibi - read only



32
33
34
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 32

def free_capacity
  @free_capacity
end

#free_space_mgr_name ⇒ Object

read only



38
39
40
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 38

def free_space_mgr_name
  @free_space_mgr_name
end

#node_name ⇒ Object

Returns the value of attribute node_name.



21
22
23
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 21

def node_name
  @node_name
end

#props ⇒ Object

A string to string property map.



26
27
28
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 26

def props
  @props
end

#provider_kind ⇒ Object

Returns the value of attribute provider_kind.



23
24
25
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 23

def provider_kind
  @provider_kind
end

#reports ⇒ Object

Currently known report messages for this storage pool



44
45
46
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 44

def reports
  @reports
end

#static_traits ⇒ Object

read only map of static storage pool traits



29
30
31
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 29

def static_traits
  @static_traits
end

#storage_pool_name ⇒ Object

Returns the value of attribute storage_pool_name.



19
20
21
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 19

def storage_pool_name
  @storage_pool_name
end

#supports_snapshots ⇒ Object

true if the storage pool supports snapshots. false otherwise



47
48
49
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 47

def supports_snapshots
  @supports_snapshots
end

#total_capacity ⇒ Object

Kibi - read only



35
36
37
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 35

def total_capacity
  @total_capacity
end

#uuid ⇒ Object

unique object id



41
42
43
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 41

def uuid
  @uuid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 50

def self.attribute_map
  {
    :'storage_pool_name' => :'storage_pool_name',
    :'node_name' => :'node_name',
    :'provider_kind' => :'provider_kind',
    :'props' => :'props',
    :'static_traits' => :'static_traits',
    :'free_capacity' => :'free_capacity',
    :'total_capacity' => :'total_capacity',
    :'free_space_mgr_name' => :'free_space_mgr_name',
    :'uuid' => :'uuid',
    :'reports' => :'reports',
    :'supports_snapshots' => :'supports_snapshots'
  }
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



216
217
218
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 72

def self.openapi_types
  {
    :'storage_pool_name' => :'String',
    :'node_name' => :'String',
    :'provider_kind' => :'ProviderKind',
    :'props' => :'Hash<String, String>',
    :'static_traits' => :'Hash<String, String>',
    :'free_capacity' => :'Integer',
    :'total_capacity' => :'Integer',
    :'free_space_mgr_name' => :'String',
    :'uuid' => :'String',
    :'reports' => :'Array<ApiCallRc>',
    :'supports_snapshots' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      storage_pool_name == o.storage_pool_name &&
      node_name == o.node_name &&
      provider_kind == o.provider_kind &&
      props == o.props &&
      static_traits == o.static_traits &&
      free_capacity == o.free_capacity &&
      total_capacity == o.total_capacity &&
      free_space_mgr_name == o.free_space_mgr_name &&
      uuid == o.uuid &&
      reports == o.reports &&
      supports_snapshots == o.supports_snapshots
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



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
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 246

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 317

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 223

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


203
204
205
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 209

def hash
  [storage_pool_name, node_name, provider_kind, props, static_traits, free_capacity, total_capacity, free_space_mgr_name, uuid, reports, supports_snapshots].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



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 162

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

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



293
294
295
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 293

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 299

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



287
288
289
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 287

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



177
178
179
180
181
 
# File 'lib/ruby-linstor-client/models/storage_pool.rb', line 177

def valid?
  return false if @storage_pool_name.nil?
  return false if @provider_kind.nil?
  true
end