Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Networking::Proxy

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Appliance::Techpreview::Networking::Proxy
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb

## Overview

``Com::Vmware::Appliance::Techpreview::Networking::Proxy`` class provides methods Proxy configuration.

## Defined Under Namespace

Classes: Message, MessageStatus, ProxyConfig, ProxyConfigMultiple, ProxyConfigTest, ProxyProtocol, ProxyStatus, TestStatus, TestStatusInfo

## Instance Method Summary (collapse)

- - (Void) delete(protocol)

  Delete a Proxy configuration for a specific protocol.

- - (Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyConfigMultiple) get

  Get proxy configuration for all protocols.

- - (Proxy) initialize(config) constructor

  Constructs a new instance.

- - (Void) set(config)

  Set Proxy configuration.

- - (Com::Vmware::Appliance::Techpreview::Networking::Proxy::TestStatusInfo) test(config)

  Test a Proxy configuration by testing the connection to the proxy server and test host.

## Constructor Details

### - (`Proxy`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    884
    885
    886
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 884

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Void`) delete(protocol)

Delete a Proxy configuration for a specific protocol.

Parameters:

- protocol (`Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol`) —

  Protocol to delete proxy of.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    925
    926
    927
    928
    929
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 925

    def delete(protocol)
        invoke_with_info(@@delete_info, {
            'protocol' => protocol,
        })
    end

### - (`Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyConfigMultiple`) get

Get proxy configuration for all protocols.

Returns:

- (`Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyConfigMultiple`) —

  proxy configuration for all protocols.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    938
    939
    940
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 938

    def get()
        invoke_with_info(@@get_info)
    end

### - (`Void`) set(config)

Set Proxy configuration. In order for this configuration to take effect a logout is required.

Parameters:

- config (`Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyConfigMultiple`) —

  List of Proxy configurations to be set.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    911
    912
    913
    914
    915
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 911

    def set(config)
        invoke_with_info(@@set_info, {
            'config' => config,
        })
    end

### - (`Com::Vmware::Appliance::Techpreview::Networking::Proxy::TestStatusInfo`) test(config)

Test a Proxy configuration by testing the connection to the proxy server and test host.

Parameters:

- config (`Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyConfigTest`) —

  Proxy configuration to test

Returns:

- (`Com::Vmware::Appliance::Techpreview::Networking::Proxy::TestStatusInfo`) —

  Status of proxy settings.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    897
    898
    899
    900
    901
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 897

    def test(config)
        invoke_with_info(@@test_info, {
            'config' => config,
        })
    end