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

Interface UdpProxyConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    UdpProxyConfig, UdpProxyConfig.Builder
    public interface UdpProxyConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getStatPrefix

        String getStatPrefix()
         The stat prefix used when emitting UDP proxy filter stats.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        com.google.protobuf.ByteString getStatPrefixBytes()
         The stat prefix used when emitting UDP proxy filter stats.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for statPrefix.

      • hasCluster

        @Deprecated
boolean hasCluster()
        Deprecated.
        envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.cluster is deprecated. See envoy/extensions/filters/udp/udp_proxy/v3/udp_proxy.proto;l=60
         The upstream cluster to connect to.
 This field is deprecated in favor of
 :ref:`matcher <envoy_v3_api_field_extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.matcher>`.
        string cluster = 2 [deprecated = true, (.validate.rules) = { ... }
        Returns:
        Whether the cluster field is set.

      • getCluster

        @Deprecated
String getCluster()
        Deprecated.
        envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.cluster is deprecated. See envoy/extensions/filters/udp/udp_proxy/v3/udp_proxy.proto;l=60
         The upstream cluster to connect to.
 This field is deprecated in favor of
 :ref:`matcher <envoy_v3_api_field_extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.matcher>`.
        string cluster = 2 [deprecated = true, (.validate.rules) = { ... }
        Returns:
        The cluster.

      • getClusterBytes

        @Deprecated
com.google.protobuf.ByteString getClusterBytes()
        Deprecated.
        envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.cluster is deprecated. See envoy/extensions/filters/udp/udp_proxy/v3/udp_proxy.proto;l=60
         The upstream cluster to connect to.
 This field is deprecated in favor of
 :ref:`matcher <envoy_v3_api_field_extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.matcher>`.
        string cluster = 2 [deprecated = true, (.validate.rules) = { ... }
        Returns:
        The bytes for cluster.

      • hasMatcher

        boolean hasMatcher()
         The match tree to use when resolving route actions for incoming requests.
 See :ref:`Routing <config_udp_listener_filters_udp_proxy_routing>` for more information.
        .xds.type.matcher.v3.Matcher matcher = 9 [(.xds.annotations.v3.field_status) = { ... }
        Returns:
        Whether the matcher field is set.

      • getMatcher

        Matcher getMatcher()
         The match tree to use when resolving route actions for incoming requests.
 See :ref:`Routing <config_udp_listener_filters_udp_proxy_routing>` for more information.
        .xds.type.matcher.v3.Matcher matcher = 9 [(.xds.annotations.v3.field_status) = { ... }
        Returns:
        The matcher.

      • getMatcherOrBuilder

        MatcherOrBuilder getMatcherOrBuilder()
         The match tree to use when resolving route actions for incoming requests.
 See :ref:`Routing <config_udp_listener_filters_udp_proxy_routing>` for more information.
        .xds.type.matcher.v3.Matcher matcher = 9 [(.xds.annotations.v3.field_status) = { ... }

      • hasIdleTimeout

        boolean hasIdleTimeout()
         The idle timeout for sessions. Idle is defined as no datagrams between received or sent by
 the session. The default if not specified is 1 minute.
        .google.protobuf.Duration idle_timeout = 3;
        Returns:
        Whether the idleTimeout field is set.

      • getIdleTimeout

        com.google.protobuf.Duration getIdleTimeout()
         The idle timeout for sessions. Idle is defined as no datagrams between received or sent by
 the session. The default if not specified is 1 minute.
        .google.protobuf.Duration idle_timeout = 3;
        Returns:
        The idleTimeout.

      • getIdleTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()
         The idle timeout for sessions. Idle is defined as no datagrams between received or sent by
 the session. The default if not specified is 1 minute.
        .google.protobuf.Duration idle_timeout = 3;

      • getUseOriginalSrcIp

        boolean getUseOriginalSrcIp()
         Use the remote downstream IP address as the sender IP address when sending packets to upstream hosts.
 This option requires Envoy to be run with the ``CAP_NET_ADMIN`` capability on Linux.
 And the IPv6 stack must be enabled on Linux kernel.
 This option does not preserve the remote downstream port.
 If this option is enabled, the IP address of sent datagrams will be changed to the remote downstream IP address.
 This means that Envoy will not receive packets that are sent by upstream hosts because the upstream hosts
 will send the packets with the remote downstream IP address as the destination. All packets will be routed
 to the remote downstream directly if there are route rules on the upstream host side.
 There are two options to return the packets back to the remote downstream.
 The first one is to use DSR (Direct Server Return).
 The other one is to configure routing rules on the upstream hosts to forward
 all packets back to Envoy and configure iptables rules on the host running Envoy to
 forward all packets from upstream hosts to the Envoy process so that Envoy can forward the packets to the downstream.
 If the platform does not support this option, Envoy will raise a configuration error.
        bool use_original_src_ip = 4;
        Returns:
        The useOriginalSrcIp.

      • getHashPoliciesList

        List<UdpProxyConfig.HashPolicy> getHashPoliciesList()
         Optional configuration for UDP proxy hash policies. If hash_policies is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
        repeated .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.HashPolicy hash_policies = 5 [(.validate.rules) = { ... }

      • getHashPolicies

        UdpProxyConfig.HashPolicy getHashPolicies​(int index)
         Optional configuration for UDP proxy hash policies. If hash_policies is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
        repeated .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.HashPolicy hash_policies = 5 [(.validate.rules) = { ... }

      • getHashPoliciesCount

        int getHashPoliciesCount()
         Optional configuration for UDP proxy hash policies. If hash_policies is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
        repeated .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.HashPolicy hash_policies = 5 [(.validate.rules) = { ... }

      • getHashPoliciesOrBuilderList

        List<? extends UdpProxyConfig.HashPolicyOrBuilder> getHashPoliciesOrBuilderList()
         Optional configuration for UDP proxy hash policies. If hash_policies is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
        repeated .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.HashPolicy hash_policies = 5 [(.validate.rules) = { ... }

      • getHashPoliciesOrBuilder

        UdpProxyConfig.HashPolicyOrBuilder getHashPoliciesOrBuilder​(int index)
         Optional configuration for UDP proxy hash policies. If hash_policies is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
        repeated .envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.HashPolicy hash_policies = 5 [(.validate.rules) = { ... }

      • hasUpstreamSocketConfig

        boolean hasUpstreamSocketConfig()
         UDP socket configuration for upstream sockets. The default for
 :ref:`prefer_gro <envoy_v3_api_field_config.core.v3.UdpSocketConfig.prefer_gro>` is true for upstream
 sockets as the assumption is datagrams will be received from a single source.
        .envoy.config.core.v3.UdpSocketConfig upstream_socket_config = 6;
        Returns:
        Whether the upstreamSocketConfig field is set.

      • getUpstreamSocketConfig

        UdpSocketConfig getUpstreamSocketConfig()
         UDP socket configuration for upstream sockets. The default for
 :ref:`prefer_gro <envoy_v3_api_field_config.core.v3.UdpSocketConfig.prefer_gro>` is true for upstream
 sockets as the assumption is datagrams will be received from a single source.
        .envoy.config.core.v3.UdpSocketConfig upstream_socket_config = 6;
        Returns:
        The upstreamSocketConfig.

      • getUpstreamSocketConfigOrBuilder

        UdpSocketConfigOrBuilder getUpstreamSocketConfigOrBuilder()
         UDP socket configuration for upstream sockets. The default for
 :ref:`prefer_gro <envoy_v3_api_field_config.core.v3.UdpSocketConfig.prefer_gro>` is true for upstream
 sockets as the assumption is datagrams will be received from a single source.
        .envoy.config.core.v3.UdpSocketConfig upstream_socket_config = 6;

      • getUsePerPacketLoadBalancing

        boolean getUsePerPacketLoadBalancing()
         Perform per packet load balancing (upstream host selection) on each received data chunk.
 The default if not specified is false, that means each data chunk is forwarded
 to upstream host selected on first chunk receival for that "session" (identified by source IP/port and local IP/port).
        bool use_per_packet_load_balancing = 7;
        Returns:
        The usePerPacketLoadBalancing.

      • getAccessLogList

        List<AccessLog> getAccessLogList()
         Configuration for access logs emitted by the UDP proxy. Note that certain UDP specific data is emitted as :ref:`Dynamic Metadata <config_access_log_format_dynamic_metadata>`.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 8;

      • getAccessLog

        AccessLog getAccessLog​(int index)
         Configuration for access logs emitted by the UDP proxy. Note that certain UDP specific data is emitted as :ref:`Dynamic Metadata <config_access_log_format_dynamic_metadata>`.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 8;

      • getAccessLogCount

        int getAccessLogCount()
         Configuration for access logs emitted by the UDP proxy. Note that certain UDP specific data is emitted as :ref:`Dynamic Metadata <config_access_log_format_dynamic_metadata>`.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 8;

      • getAccessLogOrBuilderList

        List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
         Configuration for access logs emitted by the UDP proxy. Note that certain UDP specific data is emitted as :ref:`Dynamic Metadata <config_access_log_format_dynamic_metadata>`.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 8;

      • getAccessLogOrBuilder

        AccessLogOrBuilder getAccessLogOrBuilder​(int index)
         Configuration for access logs emitted by the UDP proxy. Note that certain UDP specific data is emitted as :ref:`Dynamic Metadata <config_access_log_format_dynamic_metadata>`.
        repeated .envoy.config.accesslog.v3.AccessLog access_log = 8;