Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::Serial::Info

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Vm::Hardware::Serial::Info
  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::Serial::Info`` class contains information about a virtual serial port.

## Instance Attribute Summary (collapse)

- - (Object) allow_guest_control

  Returns the value of attribute allow_guest_control.

- - (Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo) backing

  Physical resource backing for the virtual serial port.

- - (String) label

  Device label.

- - (Object) start_connected

  Returns the value of attribute start_connected.

- - (Object) state

  Returns the value of attribute state.

- - (Boolean) yield_on_poll

  CPU yield behavior.

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

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

  Constructs a new instance.

## Constructor Details

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

    5568
    5569
    5570
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5568

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

## Instance Attribute Details

### - (`Object`) allow_guest_control

Returns the value of attribute allow_guest_control

    5558
    5559
    5560
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5558

    def allow_guest_control
      @allow_guest_control
    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo`) backing

Physical resource backing for the virtual serial port.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo`)

    5535
    5536
    5537
    5538
    5539
    5540
    5541
    5542
    5543
    5544
    5545
    5546
    5547
    5548
    5549
    5550
    5551
    5552
    5553
    5554
    5555
    5556
    5557
    5558
    5559
    5560
    5561
    5562
    5563
    5564
    5565
    5566
    5567
    5568
    5569
    5570
    5571
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5535

    class Info < 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.serial.info',
                    {
                        'label' => VAPI::Bindings::StringType.instance,
                        'yield_on_poll' => VAPI::Bindings::BooleanType.instance,
                        'backing' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo'),
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                        'start_connected' => VAPI::Bindings::BooleanType.instance,
                        'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :label,
                      :yield_on_poll,
                      :backing,
                      :state,
                      :start_connected,
                      :allow_guest_control

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

Device label.

Returns:

- (`String`)

    5535
    5536
    5537
    5538
    5539
    5540
    5541
    5542
    5543
    5544
    5545
    5546
    5547
    5548
    5549
    5550
    5551
    5552
    5553
    5554
    5555
    5556
    5557
    5558
    5559
    5560
    5561
    5562
    5563
    5564
    5565
    5566
    5567
    5568
    5569
    5570
    5571
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5535

    class Info < 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.serial.info',
                    {
                        'label' => VAPI::Bindings::StringType.instance,
                        'yield_on_poll' => VAPI::Bindings::BooleanType.instance,
                        'backing' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo'),
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                        'start_connected' => VAPI::Bindings::BooleanType.instance,
                        'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :label,
                      :yield_on_poll,
                      :backing,
                      :state,
                      :start_connected,
                      :allow_guest_control

        # 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

### - (`Object`) start_connected

Returns the value of attribute start_connected

    5558
    5559
    5560
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5558

    def start_connected
      @start_connected
    end

### - (`Object`) state

Returns the value of attribute state

    5558
    5559
    5560
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5558

    def state
      @state
    end

### - (`Boolean`) yield_on_poll

CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.

Returns:

- (`Boolean`)

    5535
    5536
    5537
    5538
    5539
    5540
    5541
    5542
    5543
    5544
    5545
    5546
    5547
    5548
    5549
    5550
    5551
    5552
    5553
    5554
    5555
    5556
    5557
    5558
    5559
    5560
    5561
    5562
    5563
    5564
    5565
    5566
    5567
    5568
    5569
    5570
    5571
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5535

    class Info < 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.serial.info',
                    {
                        'label' => VAPI::Bindings::StringType.instance,
                        'yield_on_poll' => VAPI::Bindings::BooleanType.instance,
                        'backing' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo'),
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                        'start_connected' => VAPI::Bindings::BooleanType.instance,
                        'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :label,
                      :yield_on_poll,
                      :backing,
                      :state,
                      :start_connected,
                      :allow_guest_control

        # 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

    5541
    5542
    5543
    5544
    5545
    5546
    5547
    5548
    5549
    5550
    5551
    5552
    5553
    5554
    5555
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5541

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.vm.hardware.serial.info',
            {
                'label' => VAPI::Bindings::StringType.instance,
                'yield_on_poll' => VAPI::Bindings::BooleanType.instance,
                'backing' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingInfo'),
                'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                'start_connected' => VAPI::Bindings::BooleanType.instance,
                'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
            },
            Info,
            false,
            nil)
    end