Class: IbmCloudPower::CreateCosImageImportJob

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCosImageImportJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
171
172
173
174
175
176
177
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 119

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

  if attributes.key?(:'bucket_access')
    self.bucket_access = attributes[:'bucket_access']
  else
    self.bucket_access = 'private'
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_key ⇒ Object

Cloud Object Storage access key; required for buckets with private access



19
20
21
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 19

def access_key
  @access_key
end

#bucket_access ⇒ Object

indicates if the bucket has public or private access public access require no authentication keys private access requires hmac authentication keys (access,secret)



22
23
24
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 22

def bucket_access
  @bucket_access
end

#bucket_name ⇒ Object

Cloud Object Storage bucket name; bucket-name



25
26
27
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 25

def bucket_name
  @bucket_name
end

#image_filename ⇒ Object

Cloud Object Storage image filename



28
29
30
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 28

def image_filename
  @image_filename
end

#image_name ⇒ Object

Name for the image that will be loaded into the boot image catalog



31
32
33
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 31

def image_name
  @image_name
end

#os_type ⇒ Object

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



34
35
36
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 34

def os_type
  @os_type
end

#region ⇒ Object

Cloud Object Storage region



37
38
39
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 37

def region
  @region
end

#secret_key ⇒ Object

Cloud Object Storage secret key; required for buckets with private access



40
41
42
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 40

def secret_key
  @secret_key
end

#storage_affinity ⇒ Object

Returns the value of attribute storage_affinity.



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

def storage_affinity
  @storage_affinity
end

#storage_pool ⇒ Object

Storage pool where the image will be loaded, if provided then storageType and storageAffinity will be ignored



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

def storage_pool
  @storage_pool
end

#storage_type ⇒ Object

Type of storage; will be ignored if storagePool or storageAffinity is provided. If only using storageType for storage selection then the storage pool with the most available space will be selected



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

def storage_type
  @storage_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.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_cos_image_import_job.rb', line 73

def self.attribute_map
  {
    :'access_key' => :'accessKey',
    :'bucket_access' => :'bucketAccess',
    :'bucket_name' => :'bucketName',
    :'image_filename' => :'imageFilename',
    :'image_name' => :'imageName',
    :'os_type' => :'osType',
    :'region' => :'region',
    :'secret_key' => :'secretKey',
    :'storage_affinity' => :'storageAffinity',
    :'storage_pool' => :'storagePool',
    :'storage_type' => :'storageType'
  }
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



269
270
271
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 269

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 95

def self.openapi_types
  {
    :'access_key' => :'String',
    :'bucket_access' => :'String',
    :'bucket_name' => :'String',
    :'image_filename' => :'String',
    :'image_name' => :'String',
    :'os_type' => :'String',
    :'region' => :'String',
    :'secret_key' => :'String',
    :'storage_affinity' => :'StorageAffinity',
    :'storage_pool' => :'String',
    :'storage_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_key == o.access_key &&
      bucket_access == o.bucket_access &&
      bucket_name == o.bucket_name &&
      image_filename == o.image_filename &&
      image_name == o.image_name &&
      os_type == o.os_type &&
      region == o.region &&
      secret_key == o.secret_key &&
      storage_affinity == o.storage_affinity &&
      storage_pool == o.storage_pool &&
      storage_type == o.storage_type
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 300

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 371

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 276

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


256
257
258
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 256

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



262
263
264
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 262

def hash
  [access_key, bucket_access, bucket_name, image_filename, image_name, os_type, region, secret_key, storage_affinity, storage_pool, storage_type].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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 181

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

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

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

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



347
348
349
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 347

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 353

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



341
342
343
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 341

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



204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/ibm_cloud_power/models/create_cos_image_import_job.rb', line 204

def valid?
  bucket_access_validator = EnumAttributeValidator.new('String', ["public", "private"])
  return false unless bucket_access_validator.valid?(@bucket_access)
  return false if @bucket_name.nil?
  return false if @image_filename.nil?
  return false if @image_name.nil?
  os_type_validator = EnumAttributeValidator.new('String', ["aix", "ibmi", "rhel", "sles"])
  return false unless os_type_validator.valid?(@os_type)
  return false if @region.nil?
  true
end