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

Class Geoip

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.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
Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Geoip.Builder
    Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip
    static final class 
    Geoip.CustomHeaderConfig
    Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig
    static interface 
    Geoip.CustomHeaderConfigOrBuilder
     
    static final class 
    Geoip.XffConfig
    Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig
    static interface 
    Geoip.XffConfigOrBuilder
     

    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
    CUSTOM_HEADER_CONFIG_FIELD_NUMBER
     
    static final int
    PROVIDER_FIELD_NUMBER
     
    static final int
    XFF_CONFIG_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)
     
    Geoip.CustomHeaderConfig
    getCustomHeaderConfig()
    Configuration for extracting the client IP address from a custom request header.
    Geoip.CustomHeaderConfigOrBuilder
    getCustomHeaderConfigOrBuilder()
    Configuration for extracting the client IP address from a custom request header.
    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()
     
    Geoip.XffConfig
    getXffConfig()
    Configuration for extracting the client IP address from the ``x-forwarded-for`` header.
    Geoip.XffConfigOrBuilder
    getXffConfigOrBuilder()
    Configuration for extracting the client IP address from the ``x-forwarded-for`` header.
    boolean
    hasCustomHeaderConfig()
    Configuration for extracting the client IP address from a custom request header.
    int
    hashCode()
     
    boolean
    hasProvider()
    Geoip driver specific configuration which depends on the driver being instantiated.
    boolean
    hasXffConfig()
    Configuration for extracting the client IP address from the ``x-forwarded-for`` header.
    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

    • XFF_CONFIG_FIELD_NUMBER

      public static final int XFF_CONFIG_FIELD_NUMBER
      See Also:

    • CUSTOM_HEADER_CONFIG_FIELD_NUMBER

      public static final int CUSTOM_HEADER_CONFIG_FIELD_NUMBER
      See Also:

    • PROVIDER_FIELD_NUMBER

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

    • hasXffConfig

      public boolean hasXffConfig()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Specified by:
      hasXffConfig in interface GeoipOrBuilder
      Returns:
      Whether the xffConfig field is set.

    • getXffConfig

      public Geoip.XffConfig getXffConfig()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Specified by:
      getXffConfig in interface GeoipOrBuilder
      Returns:
      The xffConfig.

    • getXffConfigOrBuilder

      public Geoip.XffConfigOrBuilder getXffConfigOrBuilder()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Specified by:
      getXffConfigOrBuilder in interface GeoipOrBuilder

    • hasCustomHeaderConfig

      public boolean hasCustomHeaderConfig()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;
      Specified by:
      hasCustomHeaderConfig in interface GeoipOrBuilder
      Returns:
      Whether the customHeaderConfig field is set.

    • getCustomHeaderConfig

      public Geoip.CustomHeaderConfig getCustomHeaderConfig()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;
      Specified by:
      getCustomHeaderConfig in interface GeoipOrBuilder
      Returns:
      The customHeaderConfig.

    • getCustomHeaderConfigOrBuilder

      public Geoip.CustomHeaderConfigOrBuilder getCustomHeaderConfigOrBuilder()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;
      Specified by:
      getCustomHeaderConfigOrBuilder in interface GeoipOrBuilder

    • hasProvider

      public boolean hasProvider()
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.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.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.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.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }
      Specified by:
      getProviderOrBuilder in interface GeoipOrBuilder

    • 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