Package io.envoyproxy.envoy.extensions.filters.network.geoip.v3

Class Geoip

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.geoip.v3.Geoip
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GeoipOrBuilder, Serializable
public final class Geoip extends com.google.protobuf.GeneratedMessageV3 implements GeoipOrBuilder
 The network geolocation filter performs IP geolocation lookups on incoming connections
 and stores the results in the connection's filter state under the well-known key
 ``envoy.geoip``. The stored data is a ``GeoipInfo`` object that supports
 serialization for access logging and field-level access.

 See :ref:`well known filter state <well_known_filter_state>` for details on accessing
 the geolocation data.
Protobuf type envoy.extensions.filters.network.geoip.v3.Geoip
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Geoip.Builder
    The network geolocation filter performs IP geolocation lookups on incoming connections and stores the results in the connection's filter state under the well-known key ``envoy.geoip``.

    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
    CLIENT_IP_FIELD_NUMBER
     
    static final int
    PROVIDER_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)
     
    String
    getClientIp()
    Configuration for dynamically extracting the client IP address used for geolocation lookups.
    com.google.protobuf.ByteString
    getClientIpBytes()
    Configuration for dynamically extracting the client IP address used for geolocation lookups.
    static Geoip
    getDefaultInstance()
     
    Geoip
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Geoip>
    getParserForType()
     
    TypedExtensionConfig
    getProvider()
    Geoip driver specific configuration which depends on the driver being instantiated.
    TypedExtensionConfigOrBuilder
    getProviderOrBuilder()
    Geoip driver specific configuration which depends on the driver being instantiated.
    int
    getSerializedSize()
     
    String
    getStatPrefix()
    The prefix to use when emitting statistics.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The prefix to use when emitting statistics.
    int
    hashCode()
     
    boolean
    hasProvider()
    Geoip driver specific configuration which depends on the driver being instantiated.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Geoip.Builder
    newBuilder()
     
    static Geoip.Builder
    newBuilder(Geoip prototype)
     
    Geoip.Builder
    newBuilderForType()
     
    protected Geoip.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Geoip
    parseDelimitedFrom(InputStream input)
     
    static Geoip
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Geoip
    parseFrom(byte[] data)
     
    static Geoip
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Geoip
    parseFrom(com.google.protobuf.ByteString data)
     
    static Geoip
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Geoip
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Geoip
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Geoip
    parseFrom(InputStream input)
     
    static Geoip
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Geoip
    parseFrom(ByteBuffer data)
     
    static Geoip
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Geoip>
    parser()
     
    Geoip.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

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • PROVIDER_FIELD_NUMBER

      public static final int PROVIDER_FIELD_NUMBER
      See Also:

    • CLIENT_IP_FIELD_NUMBER

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

    • getStatPrefix

      public String getStatPrefix()
       The prefix to use when emitting statistics. This is useful when there are multiple
 listeners configured with geoip filters, allowing stats to be grouped per listener.
 For example, with ``stat_prefix: "listener_1."``, stats would be emitted as
 ``listener_1.geoip.total``.
      string stat_prefix = 1;
      Specified by:
      getStatPrefix in interface GeoipOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The prefix to use when emitting statistics. This is useful when there are multiple
 listeners configured with geoip filters, allowing stats to be grouped per listener.
 For example, with ``stat_prefix: "listener_1."``, stats would be emitted as
 ``listener_1.geoip.total``.
      string stat_prefix = 1;
      Specified by:
      getStatPrefixBytes in interface GeoipOrBuilder
      Returns:
      The bytes for statPrefix.

    • hasProvider

      public boolean hasProvider()
       Geoip driver specific configuration which depends on the driver being instantiated.
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 2 [(.validate.rules) = { ... }
      Specified by:
      hasProvider in interface GeoipOrBuilder
      Returns:
      Whether the provider field is set.

    • getProvider

      public TypedExtensionConfig getProvider()
       Geoip driver specific configuration which depends on the driver being instantiated.
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 2 [(.validate.rules) = { ... }
      Specified by:
      getProvider in interface GeoipOrBuilder
      Returns:
      The provider.

    • getProviderOrBuilder

      public TypedExtensionConfigOrBuilder getProviderOrBuilder()
       Geoip driver specific configuration which depends on the driver being instantiated.
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 2 [(.validate.rules) = { ... }
      Specified by:
      getProviderOrBuilder in interface GeoipOrBuilder

    • getClientIp

      public String getClientIp()
       Configuration for dynamically extracting the client IP address used for geolocation lookups.

 This field accepts the same :ref:`format specifiers <config_access_log_format>` as used for
 :ref:`HTTP access logging <config_access_log>` to extract the client IP.
 The formatted result must be a valid IPv4 or IPv6 address string. For example:

 * ``%FILTER_STATE(my.custom.client.ip:PLAIN)%`` - Read from filter state populated by a preceding filter.
 * ``%DYNAMIC_METADATA(namespace:key)%`` - Read from dynamic metadata.
 * ``%REQ(X-Forwarded-For)%`` - Extract from request header (if applicable in context).

 If not specified, defaults to the downstream connection's remote address.
 If specified but the result is empty, ``-``, or not a valid IP address, the filter
 falls back to the downstream connection's remote address.

 Example reading from filter state:

 .. code-block:: yaml

   client_ip: "%FILTER_STATE(my.custom.client.ip:PLAIN)%"
      string client_ip = 3;
      Specified by:
      getClientIp in interface GeoipOrBuilder
      Returns:
      The clientIp.

    • getClientIpBytes

      public com.google.protobuf.ByteString getClientIpBytes()
       Configuration for dynamically extracting the client IP address used for geolocation lookups.

 This field accepts the same :ref:`format specifiers <config_access_log_format>` as used for
 :ref:`HTTP access logging <config_access_log>` to extract the client IP.
 The formatted result must be a valid IPv4 or IPv6 address string. For example:

 * ``%FILTER_STATE(my.custom.client.ip:PLAIN)%`` - Read from filter state populated by a preceding filter.
 * ``%DYNAMIC_METADATA(namespace:key)%`` - Read from dynamic metadata.
 * ``%REQ(X-Forwarded-For)%`` - Extract from request header (if applicable in context).

 If not specified, defaults to the downstream connection's remote address.
 If specified but the result is empty, ``-``, or not a valid IP address, the filter
 falls back to the downstream connection's remote address.

 Example reading from filter state:

 .. code-block:: yaml

   client_ip: "%FILTER_STATE(my.custom.client.ip:PLAIN)%"
      string client_ip = 3;
      Specified by:
      getClientIpBytes in interface GeoipOrBuilder
      Returns:
      The bytes for clientIp.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Geoip.Builder newBuilder()

    • newBuilder

      public static Geoip.Builder newBuilder(Geoip prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Geoip getDefaultInstance()

    • parser

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

    • getParserForType

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