class IbmCloudPower::PVMInstanceCreate

Attributes

image_id[RW]

Image ID of the image to use for the server

key_pair_name[RW]

The name of the SSH key pair provided to the server for authenticating users (looked up in the tenant's list of keys)

memory[RW]

Amount of memory allocated (in GB)

migratable[RW]

Indicates if the server is allowed to migrate between hosts

network_i_ds[RW]

(deprecated - replaced by networks) List of Network IDs

networks[RW]

The pvm instance networks information

pin_policy[RW]
placement_group[RW]

The placement group for the server

proc_type[RW]

Processor type (dedicated, shared, capped)

processors[RW]

Number of processors allocated

replicant_affinity_policy[RW]

Affinity policy for replicants being created; affinity for the same host, anti-affinity for different hosts, none for no preference

replicant_naming_scheme[RW]

How to name the created vms

replicants[RW]

Number of duplicate instances to create in this request

server_name[RW]

Name of the server to create

software_licenses[RW]
storage_type[RW]

Storage type for server deployment. Only valid when you deploy one of the IBM supplied stock images. Storage type for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage type the image was created in

sys_type[RW]

System type used to host the instance

user_data[RW]

Cloud-init user-defined data. The user-defined data is made available to the VM instance as a config drive.

virtual_cores[RW]
volume_i_ds[RW]

List of volume IDs

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/pvm_instance_create.rb, line 97
def self.attribute_map
  {
    :'server_name' => :'serverName',
    :'replicants' => :'replicants',
    :'replicant_naming_scheme' => :'replicantNamingScheme',
    :'replicant_affinity_policy' => :'replicantAffinityPolicy',
    :'image_id' => :'imageID',
    :'processors' => :'processors',
    :'proc_type' => :'procType',
    :'memory' => :'memory',
    :'network_i_ds' => :'networkIDs',
    :'networks' => :'networks',
    :'volume_i_ds' => :'volumeIDs',
    :'key_pair_name' => :'keyPairName',
    :'sys_type' => :'sysType',
    :'migratable' => :'migratable',
    :'user_data' => :'userData',
    :'storage_type' => :'storageType',
    :'software_licenses' => :'softwareLicenses',
    :'pin_policy' => :'pinPolicy',
    :'virtual_cores' => :'virtualCores',
    :'placement_group' => :'placementGroup'
  }
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/pvm_instance_create.rb, line 380
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/pvm_instance_create.rb, line 156
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::PVMInstanceCreate` 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::PVMInstanceCreate`. 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?(:'server_name')
    self.server_name = attributes[:'server_name']
  end

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

  if attributes.key?(:'replicant_naming_scheme')
    self.replicant_naming_scheme = attributes[:'replicant_naming_scheme']
  else
    self.replicant_naming_scheme = 'suffix'
  end

  if attributes.key?(:'replicant_affinity_policy')
    self.replicant_affinity_policy = attributes[:'replicant_affinity_policy']
  else
    self.replicant_affinity_policy = 'none'
  end

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

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

  if attributes.key?(:'proc_type')
    self.proc_type = attributes[:'proc_type']
  else
    self.proc_type = 'dedicated'
  end

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

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

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

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

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

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

  if attributes.key?(:'migratable')
    self.migratable = attributes[:'migratable']
  else
    self.migratable = true
  end

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

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

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

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

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

  if attributes.key?(:'placement_group')
    self.placement_group = attributes[:'placement_group']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/ibm_cloud_power/models/pvm_instance_create.rb, line 123
def self.openapi_types
  {
    :'server_name' => :'String',
    :'replicants' => :'Float',
    :'replicant_naming_scheme' => :'String',
    :'replicant_affinity_policy' => :'String',
    :'image_id' => :'String',
    :'processors' => :'Float',
    :'proc_type' => :'String',
    :'memory' => :'Float',
    :'network_i_ds' => :'Array<String>',
    :'networks' => :'Array<PVMInstanceAddNetwork>',
    :'volume_i_ds' => :'Array<String>',
    :'key_pair_name' => :'String',
    :'sys_type' => :'String',
    :'migratable' => :'Boolean',
    :'user_data' => :'String',
    :'storage_type' => :'String',
    :'software_licenses' => :'SoftwareLicenses',
    :'pin_policy' => :'PinPolicy',
    :'virtual_cores' => :'VirtualCores',
    :'placement_group' => :'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/pvm_instance_create.rb, line 340
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      server_name == o.server_name &&
      replicants == o.replicants &&
      replicant_naming_scheme == o.replicant_naming_scheme &&
      replicant_affinity_policy == o.replicant_affinity_policy &&
      image_id == o.image_id &&
      processors == o.processors &&
      proc_type == o.proc_type &&
      memory == o.memory &&
      network_i_ds == o.network_i_ds &&
      networks == o.networks &&
      volume_i_ds == o.volume_i_ds &&
      key_pair_name == o.key_pair_name &&
      sys_type == o.sys_type &&
      migratable == o.migratable &&
      user_data == o.user_data &&
      storage_type == o.storage_type &&
      software_licenses == o.software_licenses &&
      pin_policy == o.pin_policy &&
      virtual_cores == o.virtual_cores &&
      placement_group == o.placement_group
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/pvm_instance_create.rb, line 410
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/pvm_instance_create.rb, line 479
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/pvm_instance_create.rb, line 387
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/pvm_instance_create.rb, line 367
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/pvm_instance_create.rb, line 373
def hash
  [server_name, replicants, replicant_naming_scheme, replicant_affinity_policy, image_id, processors, proc_type, memory, network_i_ds, networks, volume_i_ds, key_pair_name, sys_type, migratable, user_data, storage_type, software_licenses, pin_policy, virtual_cores, placement_group].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/pvm_instance_create.rb, line 266
def list_invalid_properties
  invalid_properties = Array.new
  if @server_name.nil?
    invalid_properties.push('invalid value for "server_name", server_name cannot be nil.')
  end

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

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

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

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

  invalid_properties
end
proc_type=(proc_type) click to toggle source

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

# File lib/ibm_cloud_power/models/pvm_instance_create.rb, line 330
def proc_type=(proc_type)
  validator = EnumAttributeValidator.new('String', ["dedicated", "shared", "capped"])
  unless validator.valid?(proc_type)
    fail ArgumentError, "invalid value for \"proc_type\", must be one of #{validator.allowable_values}."
  end
  @proc_type = proc_type
end
replicant_affinity_policy=(replicant_affinity_policy) click to toggle source

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

# File lib/ibm_cloud_power/models/pvm_instance_create.rb, line 320
def replicant_affinity_policy=(replicant_affinity_policy)
  validator = EnumAttributeValidator.new('String', ["affinity", "anti-affinity", "none"])
  unless validator.valid?(replicant_affinity_policy)
    fail ArgumentError, "invalid value for \"replicant_affinity_policy\", must be one of #{validator.allowable_values}."
  end
  @replicant_affinity_policy = replicant_affinity_policy
end
replicant_naming_scheme=(replicant_naming_scheme) click to toggle source

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

# File lib/ibm_cloud_power/models/pvm_instance_create.rb, line 310
def replicant_naming_scheme=(replicant_naming_scheme)
  validator = EnumAttributeValidator.new('String', ["prefix", "suffix"])
  unless validator.valid?(replicant_naming_scheme)
    fail ArgumentError, "invalid value for \"replicant_naming_scheme\", must be one of #{validator.allowable_values}."
  end
  @replicant_naming_scheme = replicant_naming_scheme
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/pvm_instance_create.rb, line 455
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/pvm_instance_create.rb, line 461
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/pvm_instance_create.rb, line 449
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/pvm_instance_create.rb, line 293
def valid?
  return false if @server_name.nil?
  replicant_naming_scheme_validator = EnumAttributeValidator.new('String', ["prefix", "suffix"])
  return false unless replicant_naming_scheme_validator.valid?(@replicant_naming_scheme)
  replicant_affinity_policy_validator = EnumAttributeValidator.new('String', ["affinity", "anti-affinity", "none"])
  return false unless replicant_affinity_policy_validator.valid?(@replicant_affinity_policy)
  return false if @image_id.nil?
  return false if @processors.nil?
  return false if @proc_type.nil?
  proc_type_validator = EnumAttributeValidator.new('String', ["dedicated", "shared", "capped"])
  return false unless proc_type_validator.valid?(@proc_type)
  return false if @memory.nil?
  true
end