class IbmCloudPower::PVMInstance

Attributes

addresses[RW]

(deprecated - replaced by networks) The list of addresses and their network information

creation_date[RW]

Date/Time of PVM creation

disk_size[RW]

Size of allocated disk (in GB)

fault[RW]
health[RW]
image_id[RW]

The ImageID used by the server

maxmem[RW]

Maximum amount of memory that can be allocated (in GB, for resize)

maxproc[RW]

Maximum number of processors that can be allocated (for resize)

memory[RW]

Amount of memory allocated (in GB)

migratable[RW]

whether the instance can be migrated

minmem[RW]

Minimum amount of memory that can be allocated (in GB, for resize)

minproc[RW]

Minimum number of processors that can be allocated (for resize)

network_i_ds[RW]

(deprecated - replaced by networks) List of Network IDs

networks[RW]

The pvm instance networks information

operating_system[RW]

OS system information (usually version and build)

os_type[RW]

Type of the OS [aix, ibmi, redhat, sles]

pin_policy[RW]

VM pinning policy to use [none, soft, hard]

placement_group[RW]

The placement group of the server

proc_type[RW]

Processor type (dedicated, shared, capped)

processors[RW]

Number of processors allocated

progress[RW]

The progress of an operation

pvm_instance_id[RW]

PCloud PVM Instance ID

sap_profile[RW]
server_name[RW]

Name of the server

software_licenses[RW]
srcs[RW]

The pvm instance SRC lists

status[RW]

The status of the instance

storage_type[RW]

Storage type where server is deployed

sys_type[RW]

System type used to host the instance

updated_date[RW]

Date/Time of PVM last update

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.rb, line 131
def self.attribute_map
  {
    :'pvm_instance_id' => :'pvmInstanceID',
    :'server_name' => :'serverName',
    :'image_id' => :'imageID',
    :'processors' => :'processors',
    :'minproc' => :'minproc',
    :'maxproc' => :'maxproc',
    :'proc_type' => :'procType',
    :'memory' => :'memory',
    :'minmem' => :'minmem',
    :'maxmem' => :'maxmem',
    :'disk_size' => :'diskSize',
    :'network_i_ds' => :'networkIDs',
    :'volume_i_ds' => :'volumeIDs',
    :'addresses' => :'addresses',
    :'networks' => :'networks',
    :'status' => :'status',
    :'progress' => :'progress',
    :'fault' => :'fault',
    :'creation_date' => :'creationDate',
    :'updated_date' => :'updatedDate',
    :'sys_type' => :'sysType',
    :'health' => :'health',
    :'migratable' => :'migratable',
    :'storage_type' => :'storageType',
    :'software_licenses' => :'softwareLicenses',
    :'srcs' => :'srcs',
    :'pin_policy' => :'pinPolicy',
    :'os_type' => :'osType',
    :'operating_system' => :'operatingSystem',
    :'sap_profile' => :'sapProfile',
    :'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.rb, line 511
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.rb, line 214
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::PVMInstance` 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::PVMInstance`. 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?(:'pvm_instance_id')
    self.pvm_instance_id = attributes[:'pvm_instance_id']
  end

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

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

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

  if attributes.key?(:'disk_size')
    self.disk_size = attributes[:'disk_size']
  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?(:'volume_i_ds')
    if (value = attributes[:'volume_i_ds']).is_a?(Array)
      self.volume_i_ds = value
    end
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'migratable')
    self.migratable = attributes[:'migratable']
  else
    self.migratable = true
  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?(:'srcs')
    if (value = attributes[:'srcs']).is_a?(Array)
      self.srcs = value
    end
  end

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/ibm_cloud_power/models/pvm_instance.rb, line 169
def self.openapi_types
  {
    :'pvm_instance_id' => :'String',
    :'server_name' => :'String',
    :'image_id' => :'String',
    :'processors' => :'Float',
    :'minproc' => :'Float',
    :'maxproc' => :'Float',
    :'proc_type' => :'String',
    :'memory' => :'Float',
    :'minmem' => :'Float',
    :'maxmem' => :'Float',
    :'disk_size' => :'Float',
    :'network_i_ds' => :'Array<String>',
    :'volume_i_ds' => :'Array<String>',
    :'addresses' => :'Array<PVMInstanceNetwork>',
    :'networks' => :'Array<PVMInstanceNetwork>',
    :'status' => :'String',
    :'progress' => :'Float',
    :'fault' => :'PVMInstanceFault',
    :'creation_date' => :'DateTime',
    :'updated_date' => :'DateTime',
    :'sys_type' => :'String',
    :'health' => :'PVMInstanceHealth',
    :'migratable' => :'Boolean',
    :'storage_type' => :'String',
    :'software_licenses' => :'SoftwareLicenses',
    :'srcs' => :'Array<Array<SRC>>',
    :'pin_policy' => :'String',
    :'os_type' => :'String',
    :'operating_system' => :'String',
    :'sap_profile' => :'SAPProfileReference',
    :'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.rb, line 459
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pvm_instance_id == o.pvm_instance_id &&
      server_name == o.server_name &&
      image_id == o.image_id &&
      processors == o.processors &&
      minproc == o.minproc &&
      maxproc == o.maxproc &&
      proc_type == o.proc_type &&
      memory == o.memory &&
      minmem == o.minmem &&
      maxmem == o.maxmem &&
      disk_size == o.disk_size &&
      network_i_ds == o.network_i_ds &&
      volume_i_ds == o.volume_i_ds &&
      addresses == o.addresses &&
      networks == o.networks &&
      status == o.status &&
      progress == o.progress &&
      fault == o.fault &&
      creation_date == o.creation_date &&
      updated_date == o.updated_date &&
      sys_type == o.sys_type &&
      health == o.health &&
      migratable == o.migratable &&
      storage_type == o.storage_type &&
      software_licenses == o.software_licenses &&
      srcs == o.srcs &&
      pin_policy == o.pin_policy &&
      os_type == o.os_type &&
      operating_system == o.operating_system &&
      sap_profile == o.sap_profile &&
      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.rb, line 541
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.rb, line 610
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.rb, line 518
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.rb, line 498
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.rb, line 504
def hash
  [pvm_instance_id, server_name, image_id, processors, minproc, maxproc, proc_type, memory, minmem, maxmem, disk_size, network_i_ds, volume_i_ds, addresses, networks, status, progress, fault, creation_date, updated_date, sys_type, health, migratable, storage_type, software_licenses, srcs, pin_policy, os_type, operating_system, sap_profile, 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.rb, line 374
def list_invalid_properties
  invalid_properties = Array.new
  if @pvm_instance_id.nil?
    invalid_properties.push('invalid value for "pvm_instance_id", pvm_instance_id cannot be nil.')
  end

  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

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

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

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

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

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

  if @os_type.nil?
    invalid_properties.push('invalid value for "os_type", os_type 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.rb, line 449
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
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.rb, line 586
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.rb, line 592
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.rb, line 580
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.rb, line 429
def valid?
  return false if @pvm_instance_id.nil?
  return false if @server_name.nil?
  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?
  return false if @disk_size.nil?
  return false if @network_i_ds.nil?
  return false if @volume_i_ds.nil?
  return false if @status.nil?
  return false if @storage_type.nil?
  return false if @os_type.nil?
  true
end