Package io.envoyproxy.envoy.extensions.matching.input_matchers.ip.v3

Class Ip

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.matching.input_matchers.ip.v3.Ip
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, IpOrBuilder, Serializable
public final class Ip extends com.google.protobuf.GeneratedMessageV3 implements IpOrBuilder
 This input matcher matches IPv4 or IPv6 addresses against a list of CIDR
 ranges. It returns true if and only if the input IP belongs to at least one
 of these CIDR ranges. Internally, it uses a Level-Compressed trie, as
 described in the paper `IP-address lookup using LC-tries
 <https://www.nada.kth.se/~snilsson/publications/IP-address-lookup-using-LC-tries/>`_
 by S. Nilsson and G. Karlsson. For "big" lists of IPs, this matcher is more
 efficient than multiple single IP matcher, that would have a linear cost.
Protobuf type envoy.extensions.matching.input_matchers.ip.v3.Ip
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Ip.Builder
    This input matcher matches IPv4 or IPv6 addresses against a list of CIDR ranges.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 final int
    CIDR_RANGES_FIELD_NUMBER
     
    static final int
    STAT_PREFIX_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
    Description
    boolean
    equals(Object obj)
     
    CidrRange
    getCidrRanges(int index)
    Match if the IP belongs to any of these CIDR ranges.
    int
    getCidrRangesCount()
    Match if the IP belongs to any of these CIDR ranges.
    List<CidrRange>
    getCidrRangesList()
    Match if the IP belongs to any of these CIDR ranges.
    CidrRangeOrBuilder
    getCidrRangesOrBuilder(int index)
    Match if the IP belongs to any of these CIDR ranges.
    List<? extends CidrRangeOrBuilder>
    getCidrRangesOrBuilderList()
    Match if the IP belongs to any of these CIDR ranges.
    static Ip
    getDefaultInstance()
     
    Ip
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Ip>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getStatPrefix()
    The human readable prefix to use when emitting statistics for the IP input matcher.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The human readable prefix to use when emitting statistics for the IP input matcher.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Ip.Builder
    newBuilder()
     
    static Ip.Builder
    newBuilder(Ip prototype)
     
    Ip.Builder
    newBuilderForType()
     
    protected Ip.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Ip
    parseDelimitedFrom(InputStream input)
     
    static Ip
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Ip
    parseFrom(byte[] data)
     
    static Ip
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Ip
    parseFrom(com.google.protobuf.ByteString data)
     
    static Ip
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Ip
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Ip
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Ip
    parseFrom(InputStream input)
     
    static Ip
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Ip
    parseFrom(ByteBuffer data)
     
    static Ip
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Ip>
    parser()
     
    Ip.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • CIDR_RANGES_FIELD_NUMBER

      public static final int CIDR_RANGES_FIELD_NUMBER
      See Also:

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getCidrRangesList

      public List<CidrRange> getCidrRangesList()
       Match if the IP belongs to any of these CIDR ranges.
      repeated .envoy.config.core.v3.CidrRange cidr_ranges = 1 [(.validate.rules) = { ... }
      Specified by:
      getCidrRangesList in interface IpOrBuilder

    • getCidrRangesOrBuilderList

      public List<? extends CidrRangeOrBuilder> getCidrRangesOrBuilderList()
       Match if the IP belongs to any of these CIDR ranges.
      repeated .envoy.config.core.v3.CidrRange cidr_ranges = 1 [(.validate.rules) = { ... }
      Specified by:
      getCidrRangesOrBuilderList in interface IpOrBuilder

    • getCidrRangesCount

      public int getCidrRangesCount()
       Match if the IP belongs to any of these CIDR ranges.
      repeated .envoy.config.core.v3.CidrRange cidr_ranges = 1 [(.validate.rules) = { ... }
      Specified by:
      getCidrRangesCount in interface IpOrBuilder

    • getCidrRanges

      public CidrRange getCidrRanges(int index)
       Match if the IP belongs to any of these CIDR ranges.
      repeated .envoy.config.core.v3.CidrRange cidr_ranges = 1 [(.validate.rules) = { ... }
      Specified by:
      getCidrRanges in interface IpOrBuilder

    • getCidrRangesOrBuilder

      public CidrRangeOrBuilder getCidrRangesOrBuilder(int index)
       Match if the IP belongs to any of these CIDR ranges.
      repeated .envoy.config.core.v3.CidrRange cidr_ranges = 1 [(.validate.rules) = { ... }
      Specified by:
      getCidrRangesOrBuilder in interface IpOrBuilder

    • getStatPrefix

      public String getStatPrefix()
       The human readable prefix to use when emitting statistics for the IP input
 matcher. Names in the table below are concatenated to this prefix.

 .. csv-table::
    :header: Name, Type, Description
    :widths: 1, 1, 2

    ip_parsing_failed, Counter, Total number of IP addresses the matcher was unable to parse
      string stat_prefix = 2 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefix in interface IpOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The human readable prefix to use when emitting statistics for the IP input
 matcher. Names in the table below are concatenated to this prefix.

 .. csv-table::
    :header: Name, Type, Description
    :widths: 1, 1, 2

    ip_parsing_failed, Counter, Total number of IP addresses the matcher was unable to parse
      string stat_prefix = 2 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefixBytes in interface IpOrBuilder
      Returns:
      The bytes for statPrefix.

    • 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 Ip parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Ip parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Ip parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Ip parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Ip parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Ip parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Ip.Builder newBuilder()

    • newBuilder

      public static Ip.Builder newBuilder(Ip prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Ip getDefaultInstance()

    • parser

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

    • getParserForType

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