Package io.envoyproxy.envoy.extensions.filters.udp.udp_proxy.v3

Interface UdpProxyConfig.UdpTunnelingConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UdpProxyConfig.UdpTunnelingConfig, UdpProxyConfig.UdpTunnelingConfig.Builder
Enclosing class:
UdpProxyConfig
public static interface UdpProxyConfig.UdpTunnelingConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    UdpProxyConfig.UdpTunnelingConfig.BufferOptions
    getBufferOptions()
    If configured, the filter will buffer datagrams in case that it is waiting for the upstream to be ready, whether if it is during the connection process or due to upstream buffer watermarks.
    UdpProxyConfig.UdpTunnelingConfig.BufferOptionsOrBuilder
    getBufferOptionsOrBuilder()
    If configured, the filter will buffer datagrams in case that it is waiting for the upstream to be ready, whether if it is during the connection process or due to upstream buffer watermarks.
    int
    getDefaultTargetPort()
    The default target port to send in the CONNECT headers to the upstream proxy.
    HeaderValueOption
    getHeadersToAdd(int index)
    Additional request headers to upstream proxy.
    int
    getHeadersToAddCount()
    Additional request headers to upstream proxy.
    List<HeaderValueOption>
    getHeadersToAddList()
    Additional request headers to upstream proxy.
    HeaderValueOptionOrBuilder
    getHeadersToAddOrBuilder(int index)
    Additional request headers to upstream proxy.
    List<? extends HeaderValueOptionOrBuilder>
    getHeadersToAddOrBuilderList()
    Additional request headers to upstream proxy.
    String
    getPostPath()
    The path used with POST method.
    com.google.protobuf.ByteString
    getPostPathBytes()
    The path used with POST method.
    boolean
    getPropagateResponseHeaders()
    Save the response headers to the downstream info filter state for consumption by the session filters.
    boolean
    getPropagateResponseTrailers()
    Save the response trailers to the downstream info filter state for consumption by the session filters.
    String
    getProxyHost()
    The hostname to send in the synthesized CONNECT headers to the upstream proxy.
    com.google.protobuf.ByteString
    getProxyHostBytes()
    The hostname to send in the synthesized CONNECT headers to the upstream proxy.
    com.google.protobuf.UInt32Value
    getProxyPort()
    Optional port value to add to the HTTP request URI.
    com.google.protobuf.UInt32ValueOrBuilder
    getProxyPortOrBuilder()
    Optional port value to add to the HTTP request URI.
    UdpProxyConfig.UdpTunnelingConfig.RetryOptions
    getRetryOptions()
    Optional retry options, in case connecting to the upstream failed.
    UdpProxyConfig.UdpTunnelingConfig.RetryOptionsOrBuilder
    getRetryOptionsOrBuilder()
    Optional retry options, in case connecting to the upstream failed.
    String
    getTargetHost()
    The target host to send in the synthesized CONNECT headers to the upstream proxy.
    com.google.protobuf.ByteString
    getTargetHostBytes()
    The target host to send in the synthesized CONNECT headers to the upstream proxy.
    boolean
    getUsePost()
    Use POST method instead of CONNECT method to tunnel the UDP stream. .. note:: If use_post is set, the upstream stream does not comply with the connect-udp RFC, and instead it will be a POST request. the path used in the headers will be set from the post_path field, and the headers will not contain the target host and target port, as required by the connect-udp protocol.
    boolean
    hasBufferOptions()
    If configured, the filter will buffer datagrams in case that it is waiting for the upstream to be ready, whether if it is during the connection process or due to upstream buffer watermarks.
    boolean
    hasProxyPort()
    Optional port value to add to the HTTP request URI.
    boolean
    hasRetryOptions()
    Optional retry options, in case connecting to the upstream failed.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getProxyHost

      String getProxyHost()
       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 filter state

 .. code-block:: yaml

    tunneling_config:
      proxy_host: "%FILTER_STATE(proxy.host.key:PLAIN)%"
      string proxy_host = 1 [(.validate.rules) = { ... }
      Returns:
      The proxyHost.

    • getProxyHostBytes

      com.google.protobuf.ByteString getProxyHostBytes()
       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 filter state

 .. code-block:: yaml

    tunneling_config:
      proxy_host: "%FILTER_STATE(proxy.host.key:PLAIN)%"
      string proxy_host = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for proxyHost.

    • hasProxyPort

      boolean hasProxyPort()
       Optional port value to add to the HTTP request URI.
 This value can be overridden per-session by setting the required port value for
 the filter state key ``udp.connect.proxy_port``.
      .google.protobuf.UInt32Value proxy_port = 2;
      Returns:
      Whether the proxyPort field is set.

    • getProxyPort

      com.google.protobuf.UInt32Value getProxyPort()
       Optional port value to add to the HTTP request URI.
 This value can be overridden per-session by setting the required port value for
 the filter state key ``udp.connect.proxy_port``.
      .google.protobuf.UInt32Value proxy_port = 2;
      Returns:
      The proxyPort.

    • getProxyPortOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getProxyPortOrBuilder()
       Optional port value to add to the HTTP request URI.
 This value can be overridden per-session by setting the required port value for
 the filter state key ``udp.connect.proxy_port``.
      .google.protobuf.UInt32Value proxy_port = 2;

    • getTargetHost

      String getTargetHost()
       The target host 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 target host using filter state

 .. code-block:: yaml

    tunneling_config:
      target_host: "%FILTER_STATE(target.host.key:PLAIN)%"
      string target_host = 3 [(.validate.rules) = { ... }
      Returns:
      The targetHost.

    • getTargetHostBytes

      com.google.protobuf.ByteString getTargetHostBytes()
       The target host 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 target host using filter state

 .. code-block:: yaml

    tunneling_config:
      target_host: "%FILTER_STATE(target.host.key:PLAIN)%"
      string target_host = 3 [(.validate.rules) = { ... }
      Returns:
      The bytes for targetHost.

    • getDefaultTargetPort

      int getDefaultTargetPort()
       The default target port to send in the CONNECT headers to the upstream proxy.
 This value can be overridden per-session by setting the required port value for
 the filter state key ``udp.connect.target_port``.
      uint32 default_target_port = 4 [(.validate.rules) = { ... }
      Returns:
      The defaultTargetPort.

    • getUsePost

      boolean getUsePost()
       Use POST method instead of CONNECT method to tunnel the UDP stream.

 .. note::
   If use_post is set, the upstream stream does not comply with the connect-udp RFC, and
   instead it will be a POST request. the path used in the headers will be set from the
   post_path field, and the headers will not contain the target host and target port, as
   required by the connect-udp protocol. This flag should be used carefully.
      bool use_post = 5;
      Returns:
      The usePost.

    • getPostPath

      String getPostPath()
       The path used with POST method. Default path is ``/``. If post path is specified and
 use_post field isn't true, it will be rejected.
      string post_path = 6;
      Returns:
      The postPath.

    • getPostPathBytes

      com.google.protobuf.ByteString getPostPathBytes()
       The path used with POST method. Default path is ``/``. If post path is specified and
 use_post field isn't true, it will be rejected.
      string post_path = 6;
      Returns:
      The bytes for postPath.

    • hasRetryOptions

      boolean hasRetryOptions()
       Optional retry options, in case connecting to the upstream failed.
      .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.UdpTunnelingConfig.RetryOptions retry_options = 7;
      Returns:
      Whether the retryOptions field is set.

    • getRetryOptions

      UdpProxyConfig.UdpTunnelingConfig.RetryOptions getRetryOptions()
       Optional retry options, in case connecting to the upstream failed.
      .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.UdpTunnelingConfig.RetryOptions retry_options = 7;
      Returns:
      The retryOptions.

    • getRetryOptionsOrBuilder

      UdpProxyConfig.UdpTunnelingConfig.RetryOptionsOrBuilder getRetryOptionsOrBuilder()
       Optional retry options, in case connecting to the upstream failed.
      .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.UdpTunnelingConfig.RetryOptions retry_options = 7;

    • getHeadersToAddList

      List<HeaderValueOption> getHeadersToAddList()
       Additional request headers to upstream proxy. Neither ``:-prefixed`` pseudo-headers
 nor the Host: header can be overridden. Values of the added headers evaluates command
 operators if they are set in the value template.

 Example: dynamically set a header with the local port

 .. code-block:: yaml

    headers_to_add:
    - header:
        key: original_dst_port
        value: "%DOWNSTREAM_LOCAL_PORT%"
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 8 [(.validate.rules) = { ... }

    • getHeadersToAdd

      HeaderValueOption getHeadersToAdd(int index)
       Additional request headers to upstream proxy. Neither ``:-prefixed`` pseudo-headers
 nor the Host: header can be overridden. Values of the added headers evaluates command
 operators if they are set in the value template.

 Example: dynamically set a header with the local port

 .. code-block:: yaml

    headers_to_add:
    - header:
        key: original_dst_port
        value: "%DOWNSTREAM_LOCAL_PORT%"
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 8 [(.validate.rules) = { ... }

    • getHeadersToAddCount

      int getHeadersToAddCount()
       Additional request headers to upstream proxy. Neither ``:-prefixed`` pseudo-headers
 nor the Host: header can be overridden. Values of the added headers evaluates command
 operators if they are set in the value template.

 Example: dynamically set a header with the local port

 .. code-block:: yaml

    headers_to_add:
    - header:
        key: original_dst_port
        value: "%DOWNSTREAM_LOCAL_PORT%"
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 8 [(.validate.rules) = { ... }

    • getHeadersToAddOrBuilderList

      List<? extends HeaderValueOptionOrBuilder> getHeadersToAddOrBuilderList()
       Additional request headers to upstream proxy. Neither ``:-prefixed`` pseudo-headers
 nor the Host: header can be overridden. Values of the added headers evaluates command
 operators if they are set in the value template.

 Example: dynamically set a header with the local port

 .. code-block:: yaml

    headers_to_add:
    - header:
        key: original_dst_port
        value: "%DOWNSTREAM_LOCAL_PORT%"
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 8 [(.validate.rules) = { ... }

    • getHeadersToAddOrBuilder

      HeaderValueOptionOrBuilder getHeadersToAddOrBuilder(int index)
       Additional request headers to upstream proxy. Neither ``:-prefixed`` pseudo-headers
 nor the Host: header can be overridden. Values of the added headers evaluates command
 operators if they are set in the value template.

 Example: dynamically set a header with the local port

 .. code-block:: yaml

    headers_to_add:
    - header:
        key: original_dst_port
        value: "%DOWNSTREAM_LOCAL_PORT%"
      repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 8 [(.validate.rules) = { ... }

    • hasBufferOptions

      boolean hasBufferOptions()
       If configured, the filter will buffer datagrams in case that it is waiting for the upstream to be
 ready, whether if it is during the connection process or due to upstream buffer watermarks.
 If this field is not configured, there will be no buffering and downstream datagrams that arrive
 while the upstream is not ready will be dropped. In case this field is set but the options
 are not configured, the default values will be applied as described in the ``BufferOptions``.
      .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.UdpTunnelingConfig.BufferOptions buffer_options = 9;
      Returns:
      Whether the bufferOptions field is set.

    • getBufferOptions

      UdpProxyConfig.UdpTunnelingConfig.BufferOptions getBufferOptions()
       If configured, the filter will buffer datagrams in case that it is waiting for the upstream to be
 ready, whether if it is during the connection process or due to upstream buffer watermarks.
 If this field is not configured, there will be no buffering and downstream datagrams that arrive
 while the upstream is not ready will be dropped. In case this field is set but the options
 are not configured, the default values will be applied as described in the ``BufferOptions``.
      .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.UdpTunnelingConfig.BufferOptions buffer_options = 9;
      Returns:
      The bufferOptions.

    • getBufferOptionsOrBuilder

      UdpProxyConfig.UdpTunnelingConfig.BufferOptionsOrBuilder getBufferOptionsOrBuilder()
       If configured, the filter will buffer datagrams in case that it is waiting for the upstream to be
 ready, whether if it is during the connection process or due to upstream buffer watermarks.
 If this field is not configured, there will be no buffering and downstream datagrams that arrive
 while the upstream is not ready will be dropped. In case this field is set but the options
 are not configured, the default values will be applied as described in the ``BufferOptions``.
      .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.UdpTunnelingConfig.BufferOptions buffer_options = 9;

    • getPropagateResponseHeaders

      boolean getPropagateResponseHeaders()
       Save the response headers to the downstream info filter state for consumption
 by the session filters. The filter state key is ``envoy.udp_proxy.propagate_response_headers``.
      bool propagate_response_headers = 10;
      Returns:
      The propagateResponseHeaders.

    • getPropagateResponseTrailers

      boolean getPropagateResponseTrailers()
       Save the response trailers to the downstream info filter state for consumption
 by the session filters. The filter state key is ``envoy.udp_proxy.propagate_response_trailers``.
      bool propagate_response_trailers = 11;
      Returns:
      The propagateResponseTrailers.