Class List Method List File List

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

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

## Instance Attribute Summary (collapse)

- - (String) file

  Path of the file backing the virtual serial port.

- - (String?) host_device

  Name of the device backing the virtual serial port.

- - (URI) network_location

  URI specifying the location of the network service backing the virtual serial port.

- - (Boolean?) no_rx_loss

  Flag that enables optimized data transfer over the pipe.

- - (String) pipe

  Name of the pipe backing the virtual serial port.

- - (URI?) proxy

  Proxy service that provides network access to the network backing.

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

  Backing type for the virtual serial 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)

    5519
    5520
    5521
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5519

    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 backing the virtual serial port. This field is optional and it is only relevant when the value of ``type`` is :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.FILE` .

Returns:

- (`String`)

    5484
    5485
    5486
    5487
    5488
    5489
    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    5506
    5507
    5508
    5509
    5510
    5511
    5512
    5513
    5514
    5515
    5516
    5517
    5518
    5519
    5520
    5521
    5522
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5484

    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.serial.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device,
                      :pipe,
                      :no_rx_loss,
                      :network_location,
                      :proxy

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

Returns:

- (`String`, `nil`)

    5484
    5485
    5486
    5487
    5488
    5489
    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    5506
    5507
    5508
    5509
    5510
    5511
    5512
    5513
    5514
    5515
    5516
    5517
    5518
    5519
    5520
    5521
    5522
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5484

    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.serial.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device,
                      :pipe,
                      :no_rx_loss,
                      :network_location,
                      :proxy

        # 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

### - (`URI`) network_location

URI specifying the location of the network service backing the virtual serial port.

      * If   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingSpec.type`   is   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.NETWORK_SERVER`  , this  field  is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
       * If   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingSpec.type`   is   :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.NETWORK_CLIENT`  , this  field  is the location used by the virtual machine to connect to the remote server.

This field is optional and it is only relevant when the value of ``type`` is one of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.NETWORK_SERVER` or :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.NETWORK_CLIENT` .

Returns:

- (`URI`)

    5484
    5485
    5486
    5487
    5488
    5489
    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    5506
    5507
    5508
    5509
    5510
    5511
    5512
    5513
    5514
    5515
    5516
    5517
    5518
    5519
    5520
    5521
    5522
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5484

    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.serial.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device,
                      :pipe,
                      :no_rx_loss,
                      :network_location,
                      :proxy

        # 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`?) no_rx_loss

Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. If nil , defaults to false .

Returns:

- (`Boolean`, `nil`)

    5484
    5485
    5486
    5487
    5488
    5489
    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    5506
    5507
    5508
    5509
    5510
    5511
    5512
    5513
    5514
    5515
    5516
    5517
    5518
    5519
    5520
    5521
    5522
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5484

    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.serial.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device,
                      :pipe,
                      :no_rx_loss,
                      :network_location,
                      :proxy

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

Name of the pipe backing the virtual serial port. This field is optional and it is only relevant when the value of ``type`` is one of :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.PIPE_SERVER` or :attr:`Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType.PIPE_CLIENT` .

Returns:

- (`String`)

    5484
    5485
    5486
    5487
    5488
    5489
    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    5506
    5507
    5508
    5509
    5510
    5511
    5512
    5513
    5514
    5515
    5516
    5517
    5518
    5519
    5520
    5521
    5522
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5484

    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.serial.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device,
                      :pipe,
                      :no_rx_loss,
                      :network_location,
                      :proxy

        # 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

### - (`URI`?) proxy

Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. If nil , no proxy service should be used.

Returns:

- (`URI`, `nil`)

    5484
    5485
    5486
    5487
    5488
    5489
    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    5506
    5507
    5508
    5509
    5510
    5511
    5512
    5513
    5514
    5515
    5516
    5517
    5518
    5519
    5520
    5521
    5522
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5484

    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.serial.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device,
                      :pipe,
                      :no_rx_loss,
                      :network_location,
                      :proxy

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

Backing type for the virtual serial port.

Returns:

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

    5484
    5485
    5486
    5487
    5488
    5489
    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    5506
    5507
    5508
    5509
    5510
    5511
    5512
    5513
    5514
    5515
    5516
    5517
    5518
    5519
    5520
    5521
    5522
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5484

    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.serial.backing_spec',
                    {
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Vm::Hardware::Serial::BackingType'),
                        'file' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'host_device' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'pipe' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'no_rx_loss' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'network_location' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'proxy' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                    },
                    BackingSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :type,
                      :file,
                      :host_device,
                      :pipe,
                      :no_rx_loss,
                      :network_location,
                      :proxy

        # 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

    5490
    5491
    5492
    5493
    5494
    5495
    5496
    5497
    5498
    5499
    5500
    5501
    5502
    5503
    5504
    5505
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 5490

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