Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Vm::Hardware::Parallel::UpdateSpec
  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::UpdateSpec`` class describes the updates to be made to the configuration of a virtual parallel port.

## Instance Attribute Summary (collapse)

- - (Object) allow_guest_control

  Returns the value of attribute allow_guest_control.

- - (Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingSpec?) backing

  Physical resource backing for the virtual parallel port.

- - (Object) start_connected

  Returns the value of attribute start_connected.

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

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

  Constructs a new instance.

## Constructor Details

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

    4878
    4879
    4880
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4878

    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

    4871
    4872
    4873
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4871

    def allow_guest_control
      @allow_guest_control
    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingSpec`?) backing

Physical resource backing for the virtual parallel port.

     This  field  may only be modified if the virtual machine is not powered on or the virtual parallel port is not connected.

If nil , the value is unchanged.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingSpec`, `nil`)

    4851
    4852
    4853
    4854
    4855
    4856
    4857
    4858
    4859
    4860
    4861
    4862
    4863
    4864
    4865
    4866
    4867
    4868
    4869
    4870
    4871
    4872
    4873
    4874
    4875
    4876
    4877
    4878
    4879
    4880
    4881
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4851

    class UpdateSpec < 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.update_spec',
                    {
                        'backing' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingSpec')),
                        'start_connected' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'allow_guest_control' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    },
                    UpdateSpec,
                    false,
                    nil)
            end
        end

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

    4871
    4872
    4873
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4871

    def start_connected
      @start_connected
    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

    4857
    4858
    4859
    4860
    4861
    4862
    4863
    4864
    4865
    4866
    4867
    4868
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 4857

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.vm.hardware.parallel.update_spec',
            {
                'backing' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Parallel::BackingSpec')),
                'start_connected' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                'allow_guest_control' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
            },
            UpdateSpec,
            false,
            nil)
    end