Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyConfigTest
  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::ProxyConfigTest`` class Structure that defines proxy configuration.

## Instance Attribute Summary (collapse)

- - (String) password

  password for proxy server.

- - (Fixnum) port

  port to connect to the proxy server on.

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

  protocol being configured.

- - (String) server

  hostname or ip of proxy server.

- - (String) testhost

  Verify that a hostname (www.vmware.com) or IPv4 or Ipv6 address of the testhost is accessible through proxy.

- - (String) username

  username for proxy server.

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

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

  Constructs a new instance.

## Constructor Details

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

    1072
    1073
    1074
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1072

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

## Instance Attribute Details

### - (`String`) password

password for proxy server.

Returns:

- (`String`)

    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1039

    class ProxyConfigTest < 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.appliance.techpreview.networking.proxy.proxy_config_test',
                    {
                        'protocol' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol'),
                        'server' => VAPI::Bindings::StringType.instance,
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'username' => VAPI::Bindings::StringType.instance,
                        'password' => VAPI::Bindings::SecretType.instance,
                        'testhost' => VAPI::Bindings::StringType.instance,
                    },
                    ProxyConfigTest,
                    false,
                    nil)
            end
        end

        attr_accessor :protocol,
                      :server,
                      :port,
                      :username,
                      :password,
                      :testhost

        # 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

### - (`Fixnum`) port

port to connect to the proxy server on. A value of -1 indicates that the default port is being used.

Returns:

- (`Fixnum`)

    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1039

    class ProxyConfigTest < 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.appliance.techpreview.networking.proxy.proxy_config_test',
                    {
                        'protocol' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol'),
                        'server' => VAPI::Bindings::StringType.instance,
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'username' => VAPI::Bindings::StringType.instance,
                        'password' => VAPI::Bindings::SecretType.instance,
                        'testhost' => VAPI::Bindings::StringType.instance,
                    },
                    ProxyConfigTest,
                    false,
                    nil)
            end
        end

        attr_accessor :protocol,
                      :server,
                      :port,
                      :username,
                      :password,
                      :testhost

        # 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::Appliance::Techpreview::Networking::Proxy::ProxyProtocol`) protocol

protocol being configured.

Returns:

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

    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1039

    class ProxyConfigTest < 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.appliance.techpreview.networking.proxy.proxy_config_test',
                    {
                        'protocol' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol'),
                        'server' => VAPI::Bindings::StringType.instance,
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'username' => VAPI::Bindings::StringType.instance,
                        'password' => VAPI::Bindings::SecretType.instance,
                        'testhost' => VAPI::Bindings::StringType.instance,
                    },
                    ProxyConfigTest,
                    false,
                    nil)
            end
        end

        attr_accessor :protocol,
                      :server,
                      :port,
                      :username,
                      :password,
                      :testhost

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

hostname or ip of proxy server

Returns:

- (`String`)

    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1039

    class ProxyConfigTest < 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.appliance.techpreview.networking.proxy.proxy_config_test',
                    {
                        'protocol' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol'),
                        'server' => VAPI::Bindings::StringType.instance,
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'username' => VAPI::Bindings::StringType.instance,
                        'password' => VAPI::Bindings::SecretType.instance,
                        'testhost' => VAPI::Bindings::StringType.instance,
                    },
                    ProxyConfigTest,
                    false,
                    nil)
            end
        end

        attr_accessor :protocol,
                      :server,
                      :port,
                      :username,
                      :password,
                      :testhost

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

Verify that a hostname (www.vmware.com) or IPv4 or Ipv6 address of the testhost is accessible through proxy.

Returns:

- (`String`)

    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1039

    class ProxyConfigTest < 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.appliance.techpreview.networking.proxy.proxy_config_test',
                    {
                        'protocol' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol'),
                        'server' => VAPI::Bindings::StringType.instance,
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'username' => VAPI::Bindings::StringType.instance,
                        'password' => VAPI::Bindings::SecretType.instance,
                        'testhost' => VAPI::Bindings::StringType.instance,
                    },
                    ProxyConfigTest,
                    false,
                    nil)
            end
        end

        attr_accessor :protocol,
                      :server,
                      :port,
                      :username,
                      :password,
                      :testhost

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

username for proxy server.

Returns:

- (`String`)

    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    1065
    1066
    1067
    1068
    1069
    1070
    1071
    1072
    1073
    1074
    1075
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1039

    class ProxyConfigTest < 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.appliance.techpreview.networking.proxy.proxy_config_test',
                    {
                        'protocol' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol'),
                        'server' => VAPI::Bindings::StringType.instance,
                        'port' => VAPI::Bindings::IntegerType.instance,
                        'username' => VAPI::Bindings::StringType.instance,
                        'password' => VAPI::Bindings::SecretType.instance,
                        'testhost' => VAPI::Bindings::StringType.instance,
                    },
                    ProxyConfigTest,
                    false,
                    nil)
            end
        end

        attr_accessor :protocol,
                      :server,
                      :port,
                      :username,
                      :password,
                      :testhost

        # 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

    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1045

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.networking.proxy.proxy_config_test',
            {
                'protocol' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyProtocol'),
                'server' => VAPI::Bindings::StringType.instance,
                'port' => VAPI::Bindings::IntegerType.instance,
                'username' => VAPI::Bindings::StringType.instance,
                'password' => VAPI::Bindings::SecretType.instance,
                'testhost' => VAPI::Bindings::StringType.instance,
            },
            ProxyConfigTest,
            false,
            nil)
    end