Class: Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingSpec

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb

Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingSpec`` class provides a specification of the physical resource backing a virtual CD-ROM device.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (BackingSpec) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



971
972
973
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 971

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType?) device_access_type

Access type for the device backing. If nil , defaults to :attr:`Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType.EMULATION` .

Returns:



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 942

class BackingSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.cdrom.backing_spec',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType'),
                    'iso_file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                },
                BackingSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :iso_file,
                  :host_device,
                  :device_access_type

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String?) host_device

Name of the device that should be used as the virtual CD-ROM device backing. If nil , the virtual CD-ROM device will be configured to automatically detect a suitable host device.

Returns:

  • (String, nil) 


942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 942

class BackingSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.cdrom.backing_spec',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType'),
                    'iso_file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                },
                BackingSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :iso_file,
                  :host_device,
                  :device_access_type

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) iso_file

Path of the image file that should be used as the virtual CD-ROM device backing. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType.ISO_FILE` .

Returns:

  • (String) 


942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 942

class BackingSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.cdrom.backing_spec',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType'),
                    'iso_file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                },
                BackingSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :iso_file,
                  :host_device,
                  :device_access_type

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType) type

Backing type for the virtual CD-ROM device.

Returns:



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 942

class BackingSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.vcenter.vm.hardware.cdrom.backing_spec',
                {
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType'),
                    'iso_file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                },
                BackingSpec,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :iso_file,
                  :host_device,
                  :device_access_type

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 948

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.vm.hardware.cdrom.backing_spec',
        {
            'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType'),
            'iso_file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
        },
        BackingSpec,
        false,
        nil)
end