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

Class UdpProxyConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UdpProxyConfigOrBuilder, Serializable

public final class UdpProxyConfig
extends com.google.protobuf.GeneratedMessageV3
implements UdpProxyConfigOrBuilder

 Configuration for the UDP proxy filter.
 [#next-free-field: 6]
 

Protobuf type envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UdpProxyConfig.Builder Configuration for the UDP proxy filter.
static class	UdpProxyConfig.HashPolicy Specifies the UDP hash policy.
static interface	UdpProxyConfig.HashPolicyOrBuilder
static class	UdpProxyConfig.RouteSpecifierCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLUSTER_FIELD_NUMBER
static int	HASH_POLICIES_FIELD_NUMBER
static int	IDLE_TIMEOUT_FIELD_NUMBER
static int	STAT_PREFIX_FIELD_NUMBER
static int	USE_ORIGINAL_SRC_IP_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCluster() The upstream cluster to connect to.
com.google.protobuf.ByteString	getClusterBytes() The upstream cluster to connect to.
static UdpProxyConfig	getDefaultInstance()
UdpProxyConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<UdpProxyConfig>	getParserForType()
UdpProxyConfig.RouteSpecifierCase	getRouteSpecifierCase()
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	getUseOriginalSrcIp() Use the remote downstream IP address as the sender IP address when sending packets to upstream hosts.
int	hashCode()
boolean	hasIdleTimeout() The idle timeout for sessions.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static UdpProxyConfig.Builder	newBuilder()
static UdpProxyConfig.Builder	newBuilder(UdpProxyConfig prototype)
UdpProxyConfig.Builder	newBuilderForType()
protected UdpProxyConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static UdpProxyConfig	parseDelimitedFrom(InputStream input)
static UdpProxyConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UdpProxyConfig	parseFrom(byte[] data)
static UdpProxyConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UdpProxyConfig	parseFrom(ByteBuffer data)
static UdpProxyConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UdpProxyConfig	parseFrom(com.google.protobuf.ByteString data)
static UdpProxyConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UdpProxyConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static UdpProxyConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UdpProxyConfig	parseFrom(InputStream input)
static UdpProxyConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<UdpProxyConfig>	parser()
UdpProxyConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STAT_PREFIX_FIELD_NUMBER

public static final int STAT_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER

See Also:

Constant Field Values

IDLE_TIMEOUT_FIELD_NUMBER

public static final int IDLE_TIMEOUT_FIELD_NUMBER

See Also:

Constant Field Values

USE_ORIGINAL_SRC_IP_FIELD_NUMBER

public static final int USE_ORIGINAL_SRC_IP_FIELD_NUMBER

See Also:

Constant Field Values

HASH_POLICIES_FIELD_NUMBER

public static final int HASH_POLICIES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRouteSpecifierCase

public UdpProxyConfig.RouteSpecifierCase getRouteSpecifierCase()

Specified by:

getRouteSpecifierCase in interface UdpProxyConfigOrBuilder

getStatPrefix

public String getStatPrefix()

 The stat prefix used when emitting UDP proxy filter stats.
 

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

Specified by:

getStatPrefix in interface UdpProxyConfigOrBuilder

getStatPrefixBytes

public com.google.protobuf.ByteString getStatPrefixBytes()

 The stat prefix used when emitting UDP proxy filter stats.
 

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

Specified by:

getStatPrefixBytes in interface UdpProxyConfigOrBuilder

getCluster

public String getCluster()

 The upstream cluster to connect to.
 

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

Specified by:

getCluster in interface UdpProxyConfigOrBuilder

getClusterBytes

public com.google.protobuf.ByteString getClusterBytes()

 The upstream cluster to connect to.
 

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

Specified by:

getClusterBytes in interface UdpProxyConfigOrBuilder

hasIdleTimeout

public 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;

Specified by:

hasIdleTimeout in interface UdpProxyConfigOrBuilder

getIdleTimeout

public 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;

Specified by:

getIdleTimeout in interface UdpProxyConfigOrBuilder

getIdleTimeoutOrBuilder

public 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;

Specified by:

getIdleTimeoutOrBuilder in interface UdpProxyConfigOrBuilder

getUseOriginalSrcIp

public 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;

Specified by:

getUseOriginalSrcIp in interface UdpProxyConfigOrBuilder

getHashPoliciesList

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

Specified by:

getHashPoliciesList in interface UdpProxyConfigOrBuilder

getHashPoliciesOrBuilderList

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

Specified by:

getHashPoliciesOrBuilderList in interface UdpProxyConfigOrBuilder

getHashPoliciesCount

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

Specified by:

getHashPoliciesCount in interface UdpProxyConfigOrBuilder

getHashPolicies

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

Specified by:

getHashPolicies in interface UdpProxyConfigOrBuilder

getHashPoliciesOrBuilder

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

Specified by:

getHashPoliciesOrBuilder in interface UdpProxyConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static UdpProxyConfig parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UdpProxyConfig parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UdpProxyConfig parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UdpProxyConfig parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UdpProxyConfig parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UdpProxyConfig parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UdpProxyConfig parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static UdpProxyConfig parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static UdpProxyConfig parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static UdpProxyConfig parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static UdpProxyConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static UdpProxyConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public UdpProxyConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static UdpProxyConfig.Builder newBuilder()

newBuilder

public static UdpProxyConfig.Builder newBuilder(UdpProxyConfig prototype)

toBuilder

public UdpProxyConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected UdpProxyConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static UdpProxyConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<UdpProxyConfig> parser()

getParserForType

public com.google.protobuf.Parser<UdpProxyConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public UdpProxyConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder