Class: IbmCloudPower::Image

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Image

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
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
159
# File 'lib/ibm_cloud_power/models/image.rb', line 95

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#creation_dateObject

Creation Date



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

def creation_date
  @creation_date
end

#descriptionObject

Description



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

def description
  @description
end

#image_idObject

Image ID



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

def image_id
  @image_id
end

#last_update_dateObject

Last Update Date



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

def last_update_date
  @last_update_date
end

#nameObject

Image Name



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

def name
  @name
end

#serversObject

List of Servers that have deployed the image



47
48
49
# File 'lib/ibm_cloud_power/models/image.rb', line 47

def servers
  @servers
end

#sizeObject

Image Size



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

def size
  @size
end

#specificationsObject

Returns the value of attribute specifications.



41
42
43
# File 'lib/ibm_cloud_power/models/image.rb', line 41

def specifications
  @specifications
end

#stateObject

Image State



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

def state
  @state
end

#storage_typeObject

Storage type for image



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

def storage_type
  @storage_type
end

#taskrefObject

Returns the value of attribute taskref.



49
50
51
# File 'lib/ibm_cloud_power/models/image.rb', line 49

def taskref
  @taskref
end

#volumesObject

Image Volumes



44
45
46
# File 'lib/ibm_cloud_power/models/image.rb', line 44

def volumes
  @volumes
end

Class Method Details

.attribute_mapObject

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/ibm_cloud_power/models/image.rb', line 52

def self.attribute_map
  {
    :'image_id' => :'imageID',
    :'name' => :'name',
    :'state' => :'state',
    :'description' => :'description',
    :'size' => :'size',
    :'storage_type' => :'storageType',
    :'creation_date' => :'creationDate',
    :'last_update_date' => :'lastUpdateDate',
    :'specifications' => :'specifications',
    :'volumes' => :'volumes',
    :'servers' => :'servers',
    :'taskref' => :'taskref'
  }
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



238
239
240
# File 'lib/ibm_cloud_power/models/image.rb', line 238

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

.openapi_nullableObject

List of attributes with nullable: true



88
89
90
91
# File 'lib/ibm_cloud_power/models/image.rb', line 88

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

.openapi_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/ibm_cloud_power/models/image.rb', line 70

def self.openapi_types
  {
    :'image_id' => :'String',
    :'name' => :'String',
    :'state' => :'String',
    :'description' => :'String',
    :'size' => :'Float',
    :'storage_type' => :'String',
    :'creation_date' => :'DateTime',
    :'last_update_date' => :'DateTime',
    :'specifications' => :'ImageSpecifications',
    :'volumes' => :'Array<ImageVolume>',
    :'servers' => :'Array<String>',
    :'taskref' => :'TaskReference'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/ibm_cloud_power/models/image.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      image_id == o.image_id &&
      name == o.name &&
      state == o.state &&
      description == o.description &&
      size == o.size &&
      storage_type == o.storage_type &&
      creation_date == o.creation_date &&
      last_update_date == o.last_update_date &&
      specifications == o.specifications &&
      volumes == o.volumes &&
      servers == o.servers &&
      taskref == o.taskref
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



268
269
270
271
272
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
# File 'lib/ibm_cloud_power/models/image.rb', line 268

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



337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/ibm_cloud_power/models/image.rb', line 337

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/ibm_cloud_power/models/image.rb', line 245

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


225
226
227
# File 'lib/ibm_cloud_power/models/image.rb', line 225

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



231
232
233
# File 'lib/ibm_cloud_power/models/image.rb', line 231

def hash
  [image_id, name, state, description, size, storage_type, creation_date, last_update_date, specifications, volumes, servers, taskref].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  if @image_id.nil?
    invalid_properties.push('invalid value for "image_id", image_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 @storage_type.nil?
    invalid_properties.push('invalid value for "storage_type", storage_type 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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



313
314
315
# File 'lib/ibm_cloud_power/models/image.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/ibm_cloud_power/models/image.rb', line 319

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



307
308
309
# File 'lib/ibm_cloud_power/models/image.rb', line 307

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



194
195
196
197
198
199
200
201
202
# File 'lib/ibm_cloud_power/models/image.rb', line 194

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