Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingSpec

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingSpec
  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::Parallel::BackingSpec`` class provides a specification of the physical resource backing a virtual parallel port.

## Instance Attribute Summary (collapse)

- - (String) file

  Path of the file that should be used as the virtual parallel port backing.

- - (String?) host_device

  Name of the device that should be used as the virtual parallel port backing.

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

  Backing type for the virtual parallel port.

## 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)

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

  Constructs a new instance.

## 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)

    4756
    4757
    4758
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4756

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

## Instance Attribute Details

### - (`String`) file

Path of the file that should be used as the virtual parallel port backing. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingType.FILE` .

Returns:

- (`String`)

    4729
    4730
    4731
    4732
    4733
    4734
    4735
    4736
    4737
    4738
    4739
    4740
    4741
    4742
    4743
    4744
    4745
    4746
    4747
    4748
    4749
    4750
    4751
    4752
    4753
    4754
    4755
    4756
    4757
    4758
    4759
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4729

    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.parallel.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device

        # 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 parallel port backing. If nil , the virtual parallel port will be configured to automatically detect a suitable host device.

Returns:

- (`String`, `nil`)

    4729
    4730
    4731
    4732
    4733
    4734
    4735
    4736
    4737
    4738
    4739
    4740
    4741
    4742
    4743
    4744
    4745
    4746
    4747
    4748
    4749
    4750
    4751
    4752
    4753
    4754
    4755
    4756
    4757
    4758
    4759
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4729

    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.parallel.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device

        # 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::Parallel::BackingType`) type

Backing type for the virtual parallel port.

Returns:

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

    4729
    4730
    4731
    4732
    4733
    4734
    4735
    4736
    4737
    4738
    4739
    4740
    4741
    4742
    4743
    4744
    4745
    4746
    4747
    4748
    4749
    4750
    4751
    4752
    4753
    4754
    4755
    4756
    4757
    4758
    4759
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4729

    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.parallel.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device

        # 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

    4735
    4736
    4737
    4738
    4739
    4740
    4741
    4742
    4743
    4744
    4745
    4746
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4735

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