Class: Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingInfo

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::Parallel::BackingInfo`` class contains information about the physical resource backing a virtual parallel port.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

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) 



4711
4712
4713
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4711

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 parallel port 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::Parallel::BackingType.HOST_DEVICE` .

Returns:

  • (Boolean) 


4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4682

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.parallel.backing_info',
                {
                    '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),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect

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

Path of the file backing the virtual parallel port. 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) 


4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4682

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.parallel.backing_info',
                {
                    '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),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect

    # 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 backing the virtual parallel port. This field will be nil if ``autoDetect`` is true and the virtual parallel port is not connected or no suitable device is available on the host.

Returns:

  • (String, nil) 


4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4682

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.parallel.backing_info',
                {
                    '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),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect

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



4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4682

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.parallel.backing_info',
                {
                    '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),
                    'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                },
                BackingInfo,
                false,
                nil)
        end
    end

    attr_accessor :type,
                  :file,
                  :host_device,
                  :auto_detect

    # 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 



4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4688

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.vm.hardware.parallel.backing_info',
        {
            '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),
            'auto_detect' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
        },
        BackingInfo,
        false,
        nil)
end