class OCI::Core::Models::LaunchOptions

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

Constants

BOOT_VOLUME_TYPE_ENUM
FIRMWARE_ENUM
NETWORK_TYPE_ENUM
REMOTE_DATA_VOLUME_TYPE_ENUM

Attributes

boot_volume_type[R]

Emulation type for the boot volume.

  • `ISCSI` - ISCSI attached block storage device.

  • `SCSI` - Emulated SCSI disk.

  • `IDE` - Emulated IDE disk.

  • `VFIO` - Direct attached Virtual Function storage. This is the default option for local data

volumes on platform images.

  • `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block

storage volumes on platform images.

@return [String]

firmware[R]

Firmware used to boot VM. Select the option that matches your operating system.

  • `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating

systems that boot using MBR style bootloaders.

  • `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the

default for platform images.

@return [String]

is_consistent_volume_naming_enabled[RW]

Whether to enable consistent volume naming feature. Defaults to false. @return [BOOLEAN]

is_pv_encryption_in_transit_enabled[RW]

Deprecated. Instead use `isPvEncryptionInTransitEnabled` in {#launch_instance_details launch_instance_details}.

@return [BOOLEAN]

network_type[R]

Emulation type for the physical network interface card (NIC).

  • `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.

  • `VFIO` - Direct attached Virtual Function network controller. This is the networking type

when you launch an instance using hardware-assisted (SR-IOV) networking.

  • `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.

@return [String]

remote_data_volume_type[R]

Emulation type for volume.

  • `ISCSI` - ISCSI attached block storage device.

  • `SCSI` - Emulated SCSI disk.

  • `IDE` - Emulated IDE disk.

  • `VFIO` - Direct attached Virtual Function storage. This is the default option for local data

volumes on platform images.

  • `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block

storage volumes on platform images.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 97
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'boot_volume_type': :'bootVolumeType',
    'firmware': :'firmware',
    'network_type': :'networkType',
    'remote_data_volume_type': :'remoteDataVolumeType',
    'is_pv_encryption_in_transit_enabled': :'isPvEncryptionInTransitEnabled',
    'is_consistent_volume_naming_enabled': :'isConsistentVolumeNamingEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :boot_volume_type The value to assign to the {#boot_volume_type} property @option attributes [String] :firmware The value to assign to the {#firmware} property @option attributes [String] :network_type The value to assign to the {#network_type} property @option attributes [String] :remote_data_volume_type The value to assign to the {#remote_data_volume_type} property @option attributes [BOOLEAN] :is_pv_encryption_in_transit_enabled The value to assign to the {#is_pv_encryption_in_transit_enabled} property @option attributes [BOOLEAN] :is_consistent_volume_naming_enabled The value to assign to the {#is_consistent_volume_naming_enabled} property

# File lib/oci/core/models/launch_options.rb, line 136
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.boot_volume_type = attributes[:'bootVolumeType'] if attributes[:'bootVolumeType']

  raise 'You cannot provide both :bootVolumeType and :boot_volume_type' if attributes.key?(:'bootVolumeType') && attributes.key?(:'boot_volume_type')

  self.boot_volume_type = attributes[:'boot_volume_type'] if attributes[:'boot_volume_type']

  self.firmware = attributes[:'firmware'] if attributes[:'firmware']

  self.network_type = attributes[:'networkType'] if attributes[:'networkType']

  raise 'You cannot provide both :networkType and :network_type' if attributes.key?(:'networkType') && attributes.key?(:'network_type')

  self.network_type = attributes[:'network_type'] if attributes[:'network_type']

  self.remote_data_volume_type = attributes[:'remoteDataVolumeType'] if attributes[:'remoteDataVolumeType']

  raise 'You cannot provide both :remoteDataVolumeType and :remote_data_volume_type' if attributes.key?(:'remoteDataVolumeType') && attributes.key?(:'remote_data_volume_type')

  self.remote_data_volume_type = attributes[:'remote_data_volume_type'] if attributes[:'remote_data_volume_type']

  self.is_pv_encryption_in_transit_enabled = attributes[:'isPvEncryptionInTransitEnabled'] unless attributes[:'isPvEncryptionInTransitEnabled'].nil?

  raise 'You cannot provide both :isPvEncryptionInTransitEnabled and :is_pv_encryption_in_transit_enabled' if attributes.key?(:'isPvEncryptionInTransitEnabled') && attributes.key?(:'is_pv_encryption_in_transit_enabled')

  self.is_pv_encryption_in_transit_enabled = attributes[:'is_pv_encryption_in_transit_enabled'] unless attributes[:'is_pv_encryption_in_transit_enabled'].nil?

  self.is_consistent_volume_naming_enabled = attributes[:'isConsistentVolumeNamingEnabled'] unless attributes[:'isConsistentVolumeNamingEnabled'].nil?

  raise 'You cannot provide both :isConsistentVolumeNamingEnabled and :is_consistent_volume_naming_enabled' if attributes.key?(:'isConsistentVolumeNamingEnabled') && attributes.key?(:'is_consistent_volume_naming_enabled')

  self.is_consistent_volume_naming_enabled = attributes[:'is_consistent_volume_naming_enabled'] unless attributes[:'is_consistent_volume_naming_enabled'].nil?
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/core/models/launch_options.rb, line 111
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'boot_volume_type': :'String',
    'firmware': :'String',
    'network_type': :'String',
    'remote_data_volume_type': :'String',
    'is_pv_encryption_in_transit_enabled': :'BOOLEAN',
    'is_consistent_volume_naming_enabled': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 234
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    boot_volume_type == other.boot_volume_type &&
    firmware == other.firmware &&
    network_type == other.network_type &&
    remote_data_volume_type == other.remote_data_volume_type &&
    is_pv_encryption_in_transit_enabled == other.is_pv_encryption_in_transit_enabled &&
    is_consistent_volume_naming_enabled == other.is_consistent_volume_naming_enabled
end
boot_volume_type=(boot_volume_type) click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 179
def boot_volume_type=(boot_volume_type)
  # rubocop:disable Style/ConditionalAssignment
  if boot_volume_type && !BOOT_VOLUME_TYPE_ENUM.include?(boot_volume_type)
    OCI.logger.debug("Unknown value for 'boot_volume_type' [" + boot_volume_type + "]. Mapping to 'BOOT_VOLUME_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @boot_volume_type = BOOT_VOLUME_TYPE_UNKNOWN_ENUM_VALUE
  else
    @boot_volume_type = boot_volume_type
  end
  # rubocop:enable Style/ConditionalAssignment
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/oci/core/models/launch_options.rb, line 269
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 249
def eql?(other)
  self == other
end
firmware=(firmware) click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 192
def firmware=(firmware)
  # rubocop:disable Style/ConditionalAssignment
  if firmware && !FIRMWARE_ENUM.include?(firmware)
    OCI.logger.debug("Unknown value for 'firmware' [" + firmware + "]. Mapping to 'FIRMWARE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @firmware = FIRMWARE_UNKNOWN_ENUM_VALUE
  else
    @firmware = firmware
  end
  # rubocop:enable Style/ConditionalAssignment
end
hash() click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 258
def hash
  [boot_volume_type, firmware, network_type, remote_data_volume_type, is_pv_encryption_in_transit_enabled, is_consistent_volume_naming_enabled].hash
end
network_type=(network_type) click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 205
def network_type=(network_type)
  # rubocop:disable Style/ConditionalAssignment
  if network_type && !NETWORK_TYPE_ENUM.include?(network_type)
    OCI.logger.debug("Unknown value for 'network_type' [" + network_type + "]. Mapping to 'NETWORK_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @network_type = NETWORK_TYPE_UNKNOWN_ENUM_VALUE
  else
    @network_type = network_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
remote_data_volume_type=(remote_data_volume_type) click to toggle source

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

# File lib/oci/core/models/launch_options.rb, line 218
def remote_data_volume_type=(remote_data_volume_type)
  # rubocop:disable Style/ConditionalAssignment
  if remote_data_volume_type && !REMOTE_DATA_VOLUME_TYPE_ENUM.include?(remote_data_volume_type)
    OCI.logger.debug("Unknown value for 'remote_data_volume_type' [" + remote_data_volume_type + "]. Mapping to 'REMOTE_DATA_VOLUME_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @remote_data_volume_type = REMOTE_DATA_VOLUME_TYPE_UNKNOWN_ENUM_VALUE
  else
    @remote_data_volume_type = remote_data_volume_type
  end
  # rubocop:enable Style/ConditionalAssignment
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/oci/core/models/launch_options.rb, line 302
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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/oci/core/models/launch_options.rb, line 296
def to_s
  to_hash.to_s
end

Private Instance Methods

_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/oci/core/models/launch_options.rb, line 319
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