Class: IbmCloudPower::CreateImage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateImage

Initializes the object



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
169
170
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 114

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_key ⇒ Object

Cloud Storage access key; required for import image



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

def access_key
  @access_key
end

#bucket_name ⇒ Object

Cloud Storage bucket name; bucket-name; required for import image



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

def bucket_name
  @bucket_name
end

#disk_type ⇒ Object

Type of Disk



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

def disk_type
  @disk_type
end

#image_filename ⇒ Object

Cloud Storage image filename; required for import image



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

def image_filename
  @image_filename
end

#image_id ⇒ Object

Image ID of existing stock image; required for copy image



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

def image_id
  @image_id
end

#image_name ⇒ Object

Name to specify a custom image that is imported from Cloud Object Storage. You must not use this property when you import an available stock image. Stock image names cannot be changed.



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

def image_name
  @image_name
end

#image_path ⇒ Object

(deprecated - replaced by region, imageFilename and bucketName) Path to image starting with service endpoint and ending with image filename



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

def image_path
  @image_path
end

#os_type ⇒ Object

Image OS Type, required if importing a raw image; raw images can only be imported using the command line interface



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

def os_type
  @os_type
end

#region ⇒ Object

Cloud Storage Region; only required to access IBM Cloud Storage



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

def region
  @region
end

#secret_key ⇒ Object

Cloud Storage secret key; required for import image



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

def secret_key
  @secret_key
end

#source ⇒ Object

Source of the image. The root-project value is used to import an available stock image into a PCloud instance image catalog. The url value is used to import a custom image from a Cloud storage account into a PCloud instance image catalog.



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

def source
  @source
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 73

def self.attribute_map
  {
    :'source' => :'source',
    :'image_id' => :'imageID',
    :'image_name' => :'imageName',
    :'image_path' => :'imagePath',
    :'region' => :'region',
    :'image_filename' => :'imageFilename',
    :'bucket_name' => :'bucketName',
    :'access_key' => :'accessKey',
    :'secret_key' => :'secretKey',
    :'os_type' => :'osType',
    :'disk_type' => :'diskType'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 90

def self.openapi_types
  {
    :'source' => :'String',
    :'image_id' => :'String',
    :'image_name' => :'String',
    :'image_path' => :'String',
    :'region' => :'String',
    :'image_filename' => :'String',
    :'bucket_name' => :'String',
    :'access_key' => :'String',
    :'secret_key' => :'String',
    :'os_type' => :'String',
    :'disk_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source == o.source &&
      image_id == o.image_id &&
      image_name == o.image_name &&
      image_path == o.image_path &&
      region == o.region &&
      image_filename == o.image_filename &&
      bucket_name == o.bucket_name &&
      access_key == o.access_key &&
      secret_key == o.secret_key &&
      os_type == o.os_type &&
      disk_type == o.disk_type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



266
267
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
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 266

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 335

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



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

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

See Also:

  • `==` method


223
224
225
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



229
230
231
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 229

def hash
  [source, image_id, image_name, image_path, region, image_filename, bucket_name, access_key, secret_key, os_type, disk_type].hash
end

#list_invalid_properties ⇒ Object

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



174
175
176
177
178
179
180
181
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 174

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



311
312
313
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 311

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 317

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



305
306
307
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 305

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



185
186
187
188
189
190
191
 
# File 'lib/ibm_cloud_power/models/create_image.rb', line 185

def valid?
  return false if @source.nil?
  source_validator = EnumAttributeValidator.new('String', ["root-project", "url"])
  return false unless source_validator.valid?(@source)
  return false if @os_type.nil?
  true
end