Package io.envoyproxy.envoy.config.route.v3

Class RateLimit.Action.MaskedRemoteAddress

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.MaskedRemoteAddressOrBuilder, Serializable
    Enclosing class:
    RateLimit.Action
    public static final class RateLimit.Action.MaskedRemoteAddress
extends com.google.protobuf.GeneratedMessageV3
implements RateLimit.Action.MaskedRemoteAddressOrBuilder
     The following descriptor entry is appended to the descriptor and is populated using the
 masked address from :ref:`x-forwarded-for <config_http_conn_man_headers_x-forwarded-for>`:
 .. code-block:: cpp
   ("masked_remote_address", "<masked address from x-forwarded-for>")
    Protobuf type envoy.config.route.v3.RateLimit.Action.MaskedRemoteAddress
    See Also:
    Serialized Form

    • Field Detail

      • V4_PREFIX_MASK_LEN_FIELD_NUMBER

        public static final int V4_PREFIX_MASK_LEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • V6_PREFIX_MASK_LEN_FIELD_NUMBER

        public static final int V6_PREFIX_MASK_LEN_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

      • hasV4PrefixMaskLen

        public boolean hasV4PrefixMaskLen()
         Length of prefix mask len for IPv4 (e.g. 0, 32).
 Defaults to 32 when unset.
 For example, trusted address from x-forwarded-for is ``192.168.1.1``,
 the descriptor entry is ("masked_remote_address", "192.168.1.1/32");
 if mask len is 24, the descriptor entry is ("masked_remote_address", "192.168.1.0/24").
        .google.protobuf.UInt32Value v4_prefix_mask_len = 1 [(.validate.rules) = { ... }
        Specified by:
        hasV4PrefixMaskLen in interface RateLimit.Action.MaskedRemoteAddressOrBuilder
        Returns:
        Whether the v4PrefixMaskLen field is set.

      • getV4PrefixMaskLen

        public com.google.protobuf.UInt32Value getV4PrefixMaskLen()
         Length of prefix mask len for IPv4 (e.g. 0, 32).
 Defaults to 32 when unset.
 For example, trusted address from x-forwarded-for is ``192.168.1.1``,
 the descriptor entry is ("masked_remote_address", "192.168.1.1/32");
 if mask len is 24, the descriptor entry is ("masked_remote_address", "192.168.1.0/24").
        .google.protobuf.UInt32Value v4_prefix_mask_len = 1 [(.validate.rules) = { ... }
        Specified by:
        getV4PrefixMaskLen in interface RateLimit.Action.MaskedRemoteAddressOrBuilder
        Returns:
        The v4PrefixMaskLen.

      • getV4PrefixMaskLenOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getV4PrefixMaskLenOrBuilder()
         Length of prefix mask len for IPv4 (e.g. 0, 32).
 Defaults to 32 when unset.
 For example, trusted address from x-forwarded-for is ``192.168.1.1``,
 the descriptor entry is ("masked_remote_address", "192.168.1.1/32");
 if mask len is 24, the descriptor entry is ("masked_remote_address", "192.168.1.0/24").
        .google.protobuf.UInt32Value v4_prefix_mask_len = 1 [(.validate.rules) = { ... }
        Specified by:
        getV4PrefixMaskLenOrBuilder in interface RateLimit.Action.MaskedRemoteAddressOrBuilder

      • hasV6PrefixMaskLen

        public boolean hasV6PrefixMaskLen()
         Length of prefix mask len for IPv6 (e.g. 0, 128).
 Defaults to 128 when unset.
 For example, trusted address from x-forwarded-for is ``2001:abcd:ef01:2345:6789:abcd:ef01:234``,
 the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345:6789:abcd:ef01:234/128");
 if mask len is 64, the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345::/64").
        .google.protobuf.UInt32Value v6_prefix_mask_len = 2 [(.validate.rules) = { ... }
        Specified by:
        hasV6PrefixMaskLen in interface RateLimit.Action.MaskedRemoteAddressOrBuilder
        Returns:
        Whether the v6PrefixMaskLen field is set.

      • getV6PrefixMaskLen

        public com.google.protobuf.UInt32Value getV6PrefixMaskLen()
         Length of prefix mask len for IPv6 (e.g. 0, 128).
 Defaults to 128 when unset.
 For example, trusted address from x-forwarded-for is ``2001:abcd:ef01:2345:6789:abcd:ef01:234``,
 the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345:6789:abcd:ef01:234/128");
 if mask len is 64, the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345::/64").
        .google.protobuf.UInt32Value v6_prefix_mask_len = 2 [(.validate.rules) = { ... }
        Specified by:
        getV6PrefixMaskLen in interface RateLimit.Action.MaskedRemoteAddressOrBuilder
        Returns:
        The v6PrefixMaskLen.

      • getV6PrefixMaskLenOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getV6PrefixMaskLenOrBuilder()
         Length of prefix mask len for IPv6 (e.g. 0, 128).
 Defaults to 128 when unset.
 For example, trusted address from x-forwarded-for is ``2001:abcd:ef01:2345:6789:abcd:ef01:234``,
 the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345:6789:abcd:ef01:234/128");
 if mask len is 64, the descriptor entry is ("masked_remote_address", "2001:abcd:ef01:2345::/64").
        .google.protobuf.UInt32Value v6_prefix_mask_len = 2 [(.validate.rules) = { ... }
        Specified by:
        getV6PrefixMaskLenOrBuilder in interface RateLimit.Action.MaskedRemoteAddressOrBuilder

      • 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 RateLimit.Action.MaskedRemoteAddress parseFrom​(ByteBuffer data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MaskedRemoteAddress parseFrom​(com.google.protobuf.ByteString data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MaskedRemoteAddress parseFrom​(com.google.protobuf.ByteString data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimit.Action.MaskedRemoteAddress parseFrom​(byte[] data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

        public RateLimit.Action.MaskedRemoteAddress.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RateLimit.Action.MaskedRemoteAddress.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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