Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType
  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::BackingType`` enumerated type defines the valid backing types for a virtual CD-ROM device.

## Constant Summary

ISO_FILE =

      BackingType.new('ISO_FILE')

HOST_DEVICE =

      BackingType.new('HOST_DEVICE')

CLIENT_DEVICE =

      BackingType.new('CLIENT_DEVICE')

## Instance Attribute Summary (collapse)

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

  Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.

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

  Virtual CD-ROM device is backed by a device on the host where the virtual machine is running.

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

  Virtual CD-ROM device is backed by an ISO file.

## Class Method Summary (collapse)

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

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

- + (BackingType) from_string(value)

  Converts from a string value (perhaps off the wire) to an instance of this enum type.

## Instance Attribute Details

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

Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.

Returns:

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

    1235
    1236
    1237
    1238
    1239
    1240
    1241
    1242
    1243
    1244
    1245
    1246
    1247
    1248
    1249
    1250
    1251
    1252
    1253
    1254
    1255
    1256
    1257
    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1235

    class BackingType < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.vm.hardware.cdrom.backing_type',
                    BackingType)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [BackingType] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    BackingType.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] iso_file
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by an ISO file.
        ISO_FILE = BackingType.new('ISO_FILE')

        # @!attribute [rw] host_device
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by a device on the host where the virtual machine is running.
        HOST_DEVICE = BackingType.new('HOST_DEVICE')

        # @!attribute [rw] client_device
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.
        CLIENT_DEVICE = BackingType.new('CLIENT_DEVICE')

    end

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

Virtual CD-ROM device is backed by a device on the host where the virtual machine is running.

Returns:

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

    1235
    1236
    1237
    1238
    1239
    1240
    1241
    1242
    1243
    1244
    1245
    1246
    1247
    1248
    1249
    1250
    1251
    1252
    1253
    1254
    1255
    1256
    1257
    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1235

    class BackingType < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.vm.hardware.cdrom.backing_type',
                    BackingType)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [BackingType] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    BackingType.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] iso_file
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by an ISO file.
        ISO_FILE = BackingType.new('ISO_FILE')

        # @!attribute [rw] host_device
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by a device on the host where the virtual machine is running.
        HOST_DEVICE = BackingType.new('HOST_DEVICE')

        # @!attribute [rw] client_device
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.
        CLIENT_DEVICE = BackingType.new('CLIENT_DEVICE')

    end

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

Virtual CD-ROM device is backed by an ISO file.

Returns:

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

    1235
    1236
    1237
    1238
    1239
    1240
    1241
    1242
    1243
    1244
    1245
    1246
    1247
    1248
    1249
    1250
    1251
    1252
    1253
    1254
    1255
    1256
    1257
    1258
    1259
    1260
    1261
    1262
    1263
    1264
    1265
    1266
    1267
    1268
    1269
    1270
    1271
    1272
    1273
    1274
    1275
    1276
    1277
    1278
    1279
    1280
    1281
    1282
    1283
    1284
    1285
    1286
    1287
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1235

    class BackingType < VAPI::Bindings::VapiEnum

        class << self
            # Holds (gets or creates) the binding type metadata for this enumeration type.
            # @scope class
            # @return [VAPI::Bindings::EnumType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::EnumType.new(
                    'com.vmware.vcenter.vm.hardware.cdrom.backing_type',
                    BackingType)
            end

            # Converts from a string value (perhaps off the wire) to an instance
            # of this enum type.
            # @param value [String] the actual value of the enum instance
            # @return [BackingType] the instance found for the value, otherwise
            #         an unknown instance will be built for the value
            def from_string(value)
                begin
                    const_get(value)
                rescue NameError
                    BackingType.new('UNKNOWN', value)
                end
            end
        end

        private

        # Constructs a new instance.
        # @param value [String] the actual value of the enum instance
        # @param unknown [String] the unknown value when value is 'UKNOWN'
        def initialize(value, unknown=nil)
            super(self.class.binding_type, value, unknown)
        end

        public

        # @!attribute [rw] iso_file
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by an ISO file.
        ISO_FILE = BackingType.new('ISO_FILE')

        # @!attribute [rw] host_device
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by a device on the host where the virtual machine is running.
        HOST_DEVICE = BackingType.new('HOST_DEVICE')

        # @!attribute [rw] client_device
        #     @return [Com::Vmware::Vcenter::Vm::Hardware::Cdrom::BackingType]
        #     Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.
        CLIENT_DEVICE = BackingType.new('CLIENT_DEVICE')

    end

## Class Method Details

### + (`VAPI::Bindings::EnumType`) binding_type

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

Returns:

- (`VAPI::Bindings::EnumType`) —

  the binding type

    1241
    1242
    1243
    1244
    1245
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1241

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vcenter.vm.hardware.cdrom.backing_type',
            BackingType)
    end

### + (`BackingType`) from_string(value)

Converts from a string value (perhaps off the wire) to an instance of this enum type.

Parameters:

- value (`String`) —

  the actual value of the enum instance

Returns:

- (`BackingType`) —

  the instance found for the value, otherwise an unknown instance will be built for the value

    1252
    1253
    1254
    1255
    1256
    1257
    1258
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 1252

    def from_string(value)
        begin
            const_get(value)
        rescue NameError
            BackingType.new('UNKNOWN', value)
        end
    end