Package io.envoyproxy.envoy.extensions.filters.network.tcp_proxy.v3

Interface TcpProxy.TunnelingConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    TcpProxy.TunnelingConfig, TcpProxy.TunnelingConfig.Builder
    Enclosing class:
    TcpProxy
    public static interface TcpProxy.TunnelingConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getHostname

        String getHostname()
         The hostname to send in the synthesized CONNECT headers to the upstream proxy.
 This field evaluates command operators if set, otherwise returns hostname as is.
 Example: dynamically set hostname using downstream SNI
 .. code-block:: yaml
    tunneling_config:
      hostname: "%REQUESTED_SERVER_NAME%:443"
 Example: dynamically set hostname using dynamic metadata
 .. code-block: yaml
    tunneling_config:
      hostname: "%DYNAMIC_METADATA(tunnel:address)%"
        string hostname = 1 [(.validate.rules) = { ... }
        Returns:
        The hostname.

      • getHostnameBytes

        com.google.protobuf.ByteString getHostnameBytes()
         The hostname to send in the synthesized CONNECT headers to the upstream proxy.
 This field evaluates command operators if set, otherwise returns hostname as is.
 Example: dynamically set hostname using downstream SNI
 .. code-block:: yaml
    tunneling_config:
      hostname: "%REQUESTED_SERVER_NAME%:443"
 Example: dynamically set hostname using dynamic metadata
 .. code-block: yaml
    tunneling_config:
      hostname: "%DYNAMIC_METADATA(tunnel:address)%"
        string hostname = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for hostname.

      • getUsePost

        boolean getUsePost()
         Use POST method instead of CONNECT method to tunnel the TCP stream.
 The 'protocol: bytestream' header is also NOT set for HTTP/2 to comply with the spec.
 The upstream proxy is expected to convert POST payload as raw TCP.
        bool use_post = 2;
        Returns:
        The usePost.

      • getHeadersToAddList

        List<HeaderValueOption> getHeadersToAddList()
         Additional request headers to upstream proxy. This is mainly used to
 trigger upstream to convert POST requests back to CONNECT requests.
 Neither ``:-prefixed`` pseudo-headers nor the Host: header can be overridden.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }

      • getHeadersToAdd

        HeaderValueOption getHeadersToAdd​(int index)
         Additional request headers to upstream proxy. This is mainly used to
 trigger upstream to convert POST requests back to CONNECT requests.
 Neither ``:-prefixed`` pseudo-headers nor the Host: header can be overridden.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }

      • getHeadersToAddCount

        int getHeadersToAddCount()
         Additional request headers to upstream proxy. This is mainly used to
 trigger upstream to convert POST requests back to CONNECT requests.
 Neither ``:-prefixed`` pseudo-headers nor the Host: header can be overridden.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }

      • getHeadersToAddOrBuilderList

        List<? extends HeaderValueOptionOrBuilder> getHeadersToAddOrBuilderList()
         Additional request headers to upstream proxy. This is mainly used to
 trigger upstream to convert POST requests back to CONNECT requests.
 Neither ``:-prefixed`` pseudo-headers nor the Host: header can be overridden.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }

      • getHeadersToAddOrBuilder

        HeaderValueOptionOrBuilder getHeadersToAddOrBuilder​(int index)
         Additional request headers to upstream proxy. This is mainly used to
 trigger upstream to convert POST requests back to CONNECT requests.
 Neither ``:-prefixed`` pseudo-headers nor the Host: header can be overridden.
        repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 3 [(.validate.rules) = { ... }