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 Summary

Modifier and Type	Method and Description
String	getCluster() The upstream cluster to connect to.
com.google.protobuf.ByteString	getClusterBytes() The upstream cluster to connect to.
UdpProxyConfig.HashPolicy	getHashPolicies(int index) Optional configuration for UDP proxy hash policies.
int	getHashPoliciesCount() Optional configuration for UDP proxy hash policies.
List<UdpProxyConfig.HashPolicy>	getHashPoliciesList() Optional configuration for UDP proxy hash policies.
UdpProxyConfig.HashPolicyOrBuilder	getHashPoliciesOrBuilder(int index) Optional configuration for UDP proxy hash policies.
List<? extends UdpProxyConfig.HashPolicyOrBuilder>	getHashPoliciesOrBuilderList() Optional configuration for UDP proxy hash policies.
com.google.protobuf.Duration	getIdleTimeout() The idle timeout for sessions.
com.google.protobuf.DurationOrBuilder	getIdleTimeoutOrBuilder() The idle timeout for sessions.
UdpProxyConfig.RouteSpecifierCase	getRouteSpecifierCase()
String	getStatPrefix() The stat prefix used when emitting UDP proxy filter stats.
com.google.protobuf.ByteString	getStatPrefixBytes() The stat prefix used when emitting UDP proxy filter stats.
boolean	getUseOriginalSrcIp() Use the remote downstream IP address as the sender IP address when sending packets to upstream hosts.
boolean	hasIdleTimeout() The idle timeout for sessions.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getStatPrefix

String getStatPrefix()

 The stat prefix used when emitting UDP proxy filter stats.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

getStatPrefixBytes

com.google.protobuf.ByteString getStatPrefixBytes()

 The stat prefix used when emitting UDP proxy filter stats.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

getCluster

String getCluster()

 The upstream cluster to connect to.
 

string cluster = 2 [(.validate.rules) = { ... }

getClusterBytes

com.google.protobuf.ByteString getClusterBytes()

 The upstream cluster to connect to.
 

string cluster = 2 [(.validate.rules) = { ... }

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;

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;

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;

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) = { ... }

getRouteSpecifierCase

UdpProxyConfig.RouteSpecifierCase getRouteSpecifierCase()