Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::ConnectionInfo

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Vm::Hardware::ConnectionInfo
  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::ConnectionInfo`` class provides information about the state and configuration of a removable virtual device.

## Instance Attribute Summary (collapse)

- - (Boolean) allow_guest_control

  Flag indicating whether the guest can connect and disconnect the device.

- - (Boolean) start_connected

  Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

- - (Com::Vmware::Vcenter::Vm::Hardware::ConnectionState) state

  Connection status of the virtual 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)

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

  Constructs a new instance.

## Constructor Details

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

    6062
    6063
    6064
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6062

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

## Instance Attribute Details

### - (`Boolean`) allow_guest_control

Flag indicating whether the guest can connect and disconnect the device.

Returns:

- (`Boolean`)

    6035
    6036
    6037
    6038
    6039
    6040
    6041
    6042
    6043
    6044
    6045
    6046
    6047
    6048
    6049
    6050
    6051
    6052
    6053
    6054
    6055
    6056
    6057
    6058
    6059
    6060
    6061
    6062
    6063
    6064
    6065
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6035

    class ConnectionInfo < 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.connection_info',
                    {
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                        'start_connected' => VAPI::Bindings::BooleanType.instance,
                        'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
                    },
                    ConnectionInfo,
                    false,
                    nil)
            end
        end

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

### - (`Boolean`) start_connected

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

Returns:

- (`Boolean`)

    6035
    6036
    6037
    6038
    6039
    6040
    6041
    6042
    6043
    6044
    6045
    6046
    6047
    6048
    6049
    6050
    6051
    6052
    6053
    6054
    6055
    6056
    6057
    6058
    6059
    6060
    6061
    6062
    6063
    6064
    6065
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6035

    class ConnectionInfo < 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.connection_info',
                    {
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                        'start_connected' => VAPI::Bindings::BooleanType.instance,
                        'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
                    },
                    ConnectionInfo,
                    false,
                    nil)
            end
        end

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

### - (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`) state

Connection status of the virtual device.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::ConnectionState`)

    6035
    6036
    6037
    6038
    6039
    6040
    6041
    6042
    6043
    6044
    6045
    6046
    6047
    6048
    6049
    6050
    6051
    6052
    6053
    6054
    6055
    6056
    6057
    6058
    6059
    6060
    6061
    6062
    6063
    6064
    6065
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6035

    class ConnectionInfo < 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.connection_info',
                    {
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                        'start_connected' => VAPI::Bindings::BooleanType.instance,
                        'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
                    },
                    ConnectionInfo,
                    false,
                    nil)
            end
        end

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

    6041
    6042
    6043
    6044
    6045
    6046
    6047
    6048
    6049
    6050
    6051
    6052
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 6041

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.vm.hardware.connection_info',
            {
                'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::ConnectionState'),
                'start_connected' => VAPI::Bindings::BooleanType.instance,
                'allow_guest_control' => VAPI::Bindings::BooleanType.instance,
            },
            ConnectionInfo,
            false,
            nil)
    end