class IbmCloudPower::CreateImage

Attributes

access_key[RW]

Cloud Storage access key; required for import image

bucket_name[RW]

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

disk_type[RW]

Type of Disk

image_filename[RW]

Cloud Storage image filename; required for import image

image_id[RW]

Image ID of existing stock image; required for copy image

image_name[RW]

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.

image_path[RW]

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

os_type[RW]

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

region[RW]

Cloud Storage Region; only required to access IBM Cloud Storage

secret_key[RW]

Cloud Storage secret key; required for import image

source[RW]

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.

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ibm_cloud_power/models/create_image.rb, line 247
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/ibm_cloud_power/models/create_image.rb, line 107
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ibm_cloud_power/models/create_image.rb, line 216
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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ibm_cloud_power/models/create_image.rb, line 277
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/ibm_cloud_power/models/create_image.rb, line 346
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ibm_cloud_power/models/create_image.rb, line 254
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ibm_cloud_power/models/create_image.rb, line 234
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/ibm_cloud_power/models/create_image.rb, line 240
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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
os_type=(os_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] os_type Object to be assigned

# File lib/ibm_cloud_power/models/create_image.rb, line 206
def os_type=(os_type)
  validator = EnumAttributeValidator.new('String', ["aix", "ibmi", "redhat", "sles"])
  unless validator.valid?(os_type)
    fail ArgumentError, "invalid value for \"os_type\", must be one of #{validator.allowable_values}."
  end
  @os_type = os_type
end
source=(source) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] source Object to be assigned

# File lib/ibm_cloud_power/models/create_image.rb, line 196
def source=(source)
  validator = EnumAttributeValidator.new('String', ["root-project", "url"])
  unless validator.valid?(source)
    fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
  end
  @source = source
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ibm_cloud_power/models/create_image.rb, line 322
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ibm_cloud_power/models/create_image.rb, line 328
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ibm_cloud_power/models/create_image.rb, line 316
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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)
  os_type_validator = EnumAttributeValidator.new('String', ["aix", "ibmi", "redhat", "sles"])
  return false unless os_type_validator.valid?(@os_type)
  true
end