class IbmCloudPower::CloudInstance

Attributes

capabilities[RW]

Cloud Instance Capabilities

cloud_instance_id[RW]

Cloud Instance ID

enabled[RW]

Indicates if the cloud instance is enabled

initialized[RW]

Indicates if the cloud instance is initialized and ready for use

limits[RW]
name[RW]

Cloud Instance Name

openstack_id[RW]

The open stack ID that controls this cloud instance

pvm_instances[RW]

PVM instances owned by the Cloud Instance

region[RW]

The region the cloud instance lives

tenant_id[RW]

The tenant ID that owns this cloud instance

usage[RW]

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/cloud_instance.rb, line 49
def self.attribute_map
  {
    :'cloud_instance_id' => :'cloudInstanceID',
    :'name' => :'name',
    :'tenant_id' => :'tenantID',
    :'openstack_id' => :'openstackID',
    :'region' => :'region',
    :'enabled' => :'enabled',
    :'initialized' => :'initialized',
    :'limits' => :'limits',
    :'usage' => :'usage',
    :'capabilities' => :'capabilities',
    :'pvm_instances' => :'pvmInstances'
  }
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/cloud_instance.rb, line 248
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/cloud_instance.rb, line 90
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudPower::CloudInstance` 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::CloudInstance`. 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?(:'cloud_instance_id')
    self.cloud_instance_id = attributes[:'cloud_instance_id']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'pvm_instances')
    if (value = attributes[:'pvm_instances']).is_a?(Array)
      self.pvm_instances = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/ibm_cloud_power/models/cloud_instance.rb, line 66
def self.openapi_types
  {
    :'cloud_instance_id' => :'String',
    :'name' => :'String',
    :'tenant_id' => :'String',
    :'openstack_id' => :'String',
    :'region' => :'String',
    :'enabled' => :'Boolean',
    :'initialized' => :'Boolean',
    :'limits' => :'CloudInstanceUsageLimits',
    :'usage' => :'CloudInstanceUsageLimits',
    :'capabilities' => :'Array<String>',
    :'pvm_instances' => :'Array<PVMInstanceReference>'
  }
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/cloud_instance.rb, line 217
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cloud_instance_id == o.cloud_instance_id &&
      name == o.name &&
      tenant_id == o.tenant_id &&
      openstack_id == o.openstack_id &&
      region == o.region &&
      enabled == o.enabled &&
      initialized == o.initialized &&
      limits == o.limits &&
      usage == o.usage &&
      capabilities == o.capabilities &&
      pvm_instances == o.pvm_instances
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/cloud_instance.rb, line 278
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/cloud_instance.rb, line 347
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/cloud_instance.rb, line 255
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/cloud_instance.rb, line 235
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/cloud_instance.rb, line 241
def hash
  [cloud_instance_id, name, tenant_id, openstack_id, region, enabled, initialized, limits, usage, capabilities, pvm_instances].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/cloud_instance.rb, line 154
def list_invalid_properties
  invalid_properties = Array.new
  if @cloud_instance_id.nil?
    invalid_properties.push('invalid value for "cloud_instance_id", cloud_instance_id cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

  invalid_properties
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/cloud_instance.rb, line 323
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/cloud_instance.rb, line 329
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/cloud_instance.rb, line 317
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/cloud_instance.rb, line 201
def valid?
  return false if @cloud_instance_id.nil?
  return false if @name.nil?
  return false if @tenant_id.nil?
  return false if @openstack_id.nil?
  return false if @region.nil?
  return false if @enabled.nil?
  return false if @initialized.nil?
  return false if @limits.nil?
  return false if @usage.nil?
  return false if @pvm_instances.nil?
  true
end