Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingInfo

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingInfo
  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::BackingInfo`` class contains information about the physical resource backing a virtual CD-ROM device.

## Instance Attribute Summary (collapse)

- - (Boolean) auto_detect

  Flag indicating whether the virtual CD-ROM device is configured to automatically detect a suitable host device.

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

  Access type for the device backing.

- - (String?) host_device

  Name of the host device backing the virtual CD-ROM device.

- - (String) iso_file

  Path of the image file backing the virtual CD-ROM device.

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

  Backing type for the virtual CD-ROM device.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

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

## Instance Method Summary (collapse)

- - (BackingInfo) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`BackingInfo`) 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)

    920
    921
    922
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 920

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

## Instance Attribute Details

### - (`Boolean`) auto_detect

Flag indicating whether the virtual CD-ROM device is configured to automatically detect a suitable host device. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType.HOST_DEVICE` .

Returns:

- (`Boolean`)

    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 889

    class BackingInfo < 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_info',
                    {
                        '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),
                        'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                    },
                    BackingInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :iso_file,
                      :host_device,
                      :auto_detect,
                      :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::DeviceAccessType`) device_access_type

Access type for the device backing. This field is optional and it is only relevant when the value of ``type`` is one of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType.HOST_DEVICE` or :attr:`Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType.CLIENT_DEVICE` .

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType`)

    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 889

    class BackingInfo < 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_info',
                    {
                        '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),
                        'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                    },
                    BackingInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :iso_file,
                      :host_device,
                      :auto_detect,
                      :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 host device backing the virtual CD-ROM device. This field will be nil if ``autoDetect`` is true and the virtual CD-ROM device is not connected or no suitable device is available on the host.

Returns:

- (`String`, `nil`)

    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 889

    class BackingInfo < 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_info',
                    {
                        '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),
                        'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                    },
                    BackingInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :iso_file,
                      :host_device,
                      :auto_detect,
                      :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 backing the virtual CD-ROM device. 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`)

    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 889

    class BackingInfo < 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_info',
                    {
                        '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),
                        'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                    },
                    BackingInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :iso_file,
                      :host_device,
                      :auto_detect,
                      :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:

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

    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 889

    class BackingInfo < 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_info',
                    {
                        '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),
                        'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
                    },
                    BackingInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :iso_file,
                      :host_device,
                      :auto_detect,
                      :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

    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 895

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.vm.hardware.cdrom.backing_info',
            {
                '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),
                'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                'device_access_type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Cdrom::DeviceAccessType')),
            },
            BackingInfo,
            false,
            nil)
    end