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

Class UdpProxyConfig.HashPolicy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UdpProxyConfig.HashPolicyOrBuilder, java.io.Serializable
    Enclosing class:
    UdpProxyConfig
    public static final class UdpProxyConfig.HashPolicy
extends com.google.protobuf.GeneratedMessageV3
implements UdpProxyConfig.HashPolicyOrBuilder
     Specifies the UDP hash policy.
 The packets can be routed by hash policy.
    Protobuf type envoy.extensions.filters.udp.udp_proxy.v3.UdpProxyConfig.HashPolicy
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UdpProxyConfig.HashPolicy.Builder
      Specifies the UDP hash policy.
      static class  UdpProxyConfig.HashPolicy.PolicySpecifierCase  

      • 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

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int KEY_FIELD_NUMBER  
      static int SOURCE_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 Detail

      • newInstance

        protected java.lang.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

      • hasSourceIp

        public boolean hasSourceIp()
         The source IP will be used to compute the hash used by hash-based load balancing algorithms.
        bool source_ip = 1 [(.validate.rules) = { ... }
        Specified by:
        hasSourceIp in interface UdpProxyConfig.HashPolicyOrBuilder
        Returns:
        Whether the sourceIp field is set.

      • getSourceIp

        public boolean getSourceIp()
         The source IP will be used to compute the hash used by hash-based load balancing algorithms.
        bool source_ip = 1 [(.validate.rules) = { ... }
        Specified by:
        getSourceIp in interface UdpProxyConfig.HashPolicyOrBuilder
        Returns:
        The sourceIp.

      • hasKey

        public boolean hasKey()
         A given key will be used to compute the hash used by hash-based load balancing algorithms.
 In certain cases there is a need to direct different UDP streams jointly towards the selected set of endpoints.
 A possible use-case is VoIP telephony, where media (RTP) and its corresponding control (RTCP) belong to the same logical session,
 although they travel in separate streams. To ensure that these pair of streams are load-balanced on session level
 (instead of individual stream level), dynamically created listeners can use the same hash key for each stream in the session.
        string key = 2 [(.validate.rules) = { ... }
        Specified by:
        hasKey in interface UdpProxyConfig.HashPolicyOrBuilder
        Returns:
        Whether the key field is set.

      • getKey

        public java.lang.String getKey()
         A given key will be used to compute the hash used by hash-based load balancing algorithms.
 In certain cases there is a need to direct different UDP streams jointly towards the selected set of endpoints.
 A possible use-case is VoIP telephony, where media (RTP) and its corresponding control (RTCP) belong to the same logical session,
 although they travel in separate streams. To ensure that these pair of streams are load-balanced on session level
 (instead of individual stream level), dynamically created listeners can use the same hash key for each stream in the session.
        string key = 2 [(.validate.rules) = { ... }
        Specified by:
        getKey in interface UdpProxyConfig.HashPolicyOrBuilder
        Returns:
        The key.

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         A given key will be used to compute the hash used by hash-based load balancing algorithms.
 In certain cases there is a need to direct different UDP streams jointly towards the selected set of endpoints.
 A possible use-case is VoIP telephony, where media (RTP) and its corresponding control (RTCP) belong to the same logical session,
 although they travel in separate streams. To ensure that these pair of streams are load-balanced on session level
 (instead of individual stream level), dynamically created listeners can use the same hash key for each stream in the session.
        string key = 2 [(.validate.rules) = { ... }
        Specified by:
        getKeyBytes in interface UdpProxyConfig.HashPolicyOrBuilder
        Returns:
        The bytes for key.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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.HashPolicy parseFrom​(java.nio.ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UdpProxyConfig.HashPolicy parseFrom​(java.nio.ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UdpProxyConfig.HashPolicy parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UdpProxyConfig.HashPolicy 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.HashPolicy parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static UdpProxyConfig.HashPolicy parseFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static UdpProxyConfig.HashPolicy parseFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static UdpProxyConfig.HashPolicy parseDelimitedFrom​(java.io.InputStream input)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static UdpProxyConfig.HashPolicy parseDelimitedFrom​(java.io.InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static UdpProxyConfig.HashPolicy parseFrom​(com.google.protobuf.CodedInputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static UdpProxyConfig.HashPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public UdpProxyConfig.HashPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public UdpProxyConfig.HashPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected UdpProxyConfig.HashPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<UdpProxyConfig.HashPolicy> 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.HashPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder