Class: PulpcoreClient::StorageResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/models/storage_response.rb

Overview

Serializer for information about the storage system

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StorageResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/pulpcore_client/models/storage_response.rb', line 53

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

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

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

Instance Attribute Details

#freeObject

Number of free bytes


25
26
27
# File 'lib/pulpcore_client/models/storage_response.rb', line 25

def free
  @free
end

#totalObject

Total number of bytes


19
20
21
# File 'lib/pulpcore_client/models/storage_response.rb', line 19

def total
  @total
end

#usedObject

Number of bytes in use


22
23
24
# File 'lib/pulpcore_client/models/storage_response.rb', line 22

def used
  @used
end

Class Method Details

.attribute_mapObject

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


28
29
30
31
32
33
34
# File 'lib/pulpcore_client/models/storage_response.rb', line 28

def self.attribute_map
  {
    :'total' => :'total',
    :'used' => :'used',
    :'free' => :'free'
  }
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


189
190
191
# File 'lib/pulpcore_client/models/storage_response.rb', line 189

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

.openapi_nullableObject

List of attributes with nullable: true


46
47
48
49
# File 'lib/pulpcore_client/models/storage_response.rb', line 46

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

.openapi_typesObject

Attribute type mapping.


37
38
39
40
41
42
43
# File 'lib/pulpcore_client/models/storage_response.rb', line 37

def self.openapi_types
  {
    :'total' => :'Integer',
    :'used' => :'Integer',
    :'free' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


166
167
168
169
170
171
172
# File 'lib/pulpcore_client/models/storage_response.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      used == o.used &&
      free == o.free
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


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
247
248
249
250
251
252
# File 'lib/pulpcore_client/models/storage_response.rb', line 217

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


286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/pulpcore_client/models/storage_response.rb', line 286

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


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/pulpcore_client/models/storage_response.rb', line 196

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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

176
177
178
# File 'lib/pulpcore_client/models/storage_response.rb', line 176

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


182
183
184
# File 'lib/pulpcore_client/models/storage_response.rb', line 182

def hash
  [total, used, free].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/pulpcore_client/models/storage_response.rb', line 81

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

  if @total < 0
    invalid_properties.push('invalid value for "total", must be greater than or equal to 0.')
  end

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

  if @used < 0
    invalid_properties.push('invalid value for "used", must be greater than or equal to 0.')
  end

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

  if @free < 0
    invalid_properties.push('invalid value for "free", must be greater than or equal to 0.')
  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


262
263
264
# File 'lib/pulpcore_client/models/storage_response.rb', line 262

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


268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/pulpcore_client/models/storage_response.rb', line 268

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


256
257
258
# File 'lib/pulpcore_client/models/storage_response.rb', line 256

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


112
113
114
115
116
117
118
119
120
# File 'lib/pulpcore_client/models/storage_response.rb', line 112

def valid?
  return false if @total.nil?
  return false if @total < 0
  return false if @used.nil?
  return false if @used < 0
  return false if @free.nil?
  return false if @free < 0
  true
end