Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Techpreview::Networking::Proxy::ProxyConfig
  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::ProxyConfig`` 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) 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)

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

  Constructs a new instance.

## Constructor Details

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

    1125
    1126
    1127
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1125

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

    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1094

    class ProxyConfig < 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',
                    {
                        '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,
                    },
                    ProxyConfig,
                    false,
                    nil)
            end
        end

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

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

    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1094

    class ProxyConfig < 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',
                    {
                        '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,
                    },
                    ProxyConfig,
                    false,
                    nil)
            end
        end

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

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

    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1094

    class ProxyConfig < 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',
                    {
                        '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,
                    },
                    ProxyConfig,
                    false,
                    nil)
            end
        end

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

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

    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1094

    class ProxyConfig < 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',
                    {
                        '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,
                    },
                    ProxyConfig,
                    false,
                    nil)
            end
        end

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

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

    1094
    1095
    1096
    1097
    1098
    1099
    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    1114
    1115
    1116
    1117
    1118
    1119
    1120
    1121
    1122
    1123
    1124
    1125
    1126
    1127
    1128
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1094

    class ProxyConfig < 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',
                    {
                        '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,
                    },
                    ProxyConfig,
                    false,
                    nil)
            end
        end

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

        # 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

    1100
    1101
    1102
    1103
    1104
    1105
    1106
    1107
    1108
    1109
    1110
    1111
    1112
    1113
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/networking.rb', line 1100

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.techpreview.networking.proxy.proxy_config',
            {
                '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,
            },
            ProxyConfig,
            false,
            nil)
    end