Package io.envoyproxy.envoy.extensions.geoip_providers.maxmind.v3

Class MaxMindConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.geoip_providers.maxmind.v3.MaxMindConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MaxMindConfigOrBuilder, Serializable
public final class MaxMindConfig extends com.google.protobuf.GeneratedMessageV3 implements MaxMindConfigOrBuilder
 [#next-free-field: 7]
Protobuf type envoy.extensions.geoip_providers.maxmind.v3.MaxMindConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MaxMindConfig.Builder
    [#next-free-field: 7]

    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
    ANON_DB_PATH_FIELD_NUMBER
     
    static final int
    ASN_DB_PATH_FIELD_NUMBER
     
    static final int
    CITY_DB_PATH_FIELD_NUMBER
     
    static final int
    COMMON_PROVIDER_CONFIG_FIELD_NUMBER
     
    static final int
    COUNTRY_DB_PATH_FIELD_NUMBER
     
    static final int
    ISP_DB_PATH_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
    getAnonDbPath()
    Full file path to the MaxMind Anonymous IP database, e.g., ``/etc/GeoIP2-Anonymous-IP.mmdb``.
    com.google.protobuf.ByteString
    getAnonDbPathBytes()
    Full file path to the MaxMind Anonymous IP database, e.g., ``/etc/GeoIP2-Anonymous-IP.mmdb``.
    String
    getAsnDbPath()
    Full file path to the MaxMind ASN database, e.g., ``/etc/GeoLite2-ASN.mmdb``.
    com.google.protobuf.ByteString
    getAsnDbPathBytes()
    Full file path to the MaxMind ASN database, e.g., ``/etc/GeoLite2-ASN.mmdb``.
    String
    getCityDbPath()
    Full file path to the MaxMind city database, e.g., ``/etc/GeoLite2-City.mmdb``.
    com.google.protobuf.ByteString
    getCityDbPathBytes()
    Full file path to the MaxMind city database, e.g., ``/etc/GeoLite2-City.mmdb``.
    CommonGeoipProviderConfig
    getCommonProviderConfig()
    Common provider configuration that specifies which geolocation headers will be populated with geolocation data.
    CommonGeoipProviderConfigOrBuilder
    getCommonProviderConfigOrBuilder()
    Common provider configuration that specifies which geolocation headers will be populated with geolocation data.
    String
    getCountryDbPath()
    Full file path to the MaxMind Country database, e.g., ``/etc/GeoLite2-Country.mmdb``.
    com.google.protobuf.ByteString
    getCountryDbPathBytes()
    Full file path to the MaxMind Country database, e.g., ``/etc/GeoLite2-Country.mmdb``.
    static MaxMindConfig
    getDefaultInstance()
     
    MaxMindConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getIspDbPath()
    Full file path to the MaxMind ISP database, e.g., ``/etc/GeoLite2-ISP.mmdb``.
    com.google.protobuf.ByteString
    getIspDbPathBytes()
    Full file path to the MaxMind ISP database, e.g., ``/etc/GeoLite2-ISP.mmdb``.
    com.google.protobuf.Parser<MaxMindConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasCommonProviderConfig()
    Common provider configuration that specifies which geolocation headers will be populated with geolocation data.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MaxMindConfig.Builder
    newBuilder()
     
    static MaxMindConfig.Builder
    newBuilder(MaxMindConfig prototype)
     
    MaxMindConfig.Builder
    newBuilderForType()
     
    protected MaxMindConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static MaxMindConfig
    parseDelimitedFrom(InputStream input)
     
    static MaxMindConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MaxMindConfig
    parseFrom(byte[] data)
     
    static MaxMindConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MaxMindConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static MaxMindConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MaxMindConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MaxMindConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MaxMindConfig
    parseFrom(InputStream input)
     
    static MaxMindConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MaxMindConfig
    parseFrom(ByteBuffer data)
     
    static MaxMindConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MaxMindConfig>
    parser()
     
    MaxMindConfig.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

    • CITY_DB_PATH_FIELD_NUMBER

      public static final int CITY_DB_PATH_FIELD_NUMBER
      See Also:

    • ASN_DB_PATH_FIELD_NUMBER

      public static final int ASN_DB_PATH_FIELD_NUMBER
      See Also:

    • ANON_DB_PATH_FIELD_NUMBER

      public static final int ANON_DB_PATH_FIELD_NUMBER
      See Also:

    • ISP_DB_PATH_FIELD_NUMBER

      public static final int ISP_DB_PATH_FIELD_NUMBER
      See Also:

    • COUNTRY_DB_PATH_FIELD_NUMBER

      public static final int COUNTRY_DB_PATH_FIELD_NUMBER
      See Also:

    • COMMON_PROVIDER_CONFIG_FIELD_NUMBER

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

    • getCityDbPath

      public String getCityDbPath()
       Full file path to the MaxMind city database, e.g., ``/etc/GeoLite2-City.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
      string city_db_path = 1 [(.validate.rules) = { ... }
      Specified by:
      getCityDbPath in interface MaxMindConfigOrBuilder
      Returns:
      The cityDbPath.

    • getCityDbPathBytes

      public com.google.protobuf.ByteString getCityDbPathBytes()
       Full file path to the MaxMind city database, e.g., ``/etc/GeoLite2-City.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
      string city_db_path = 1 [(.validate.rules) = { ... }
      Specified by:
      getCityDbPathBytes in interface MaxMindConfigOrBuilder
      Returns:
      The bytes for cityDbPath.

    • getAsnDbPath

      public String getAsnDbPath()
       Full file path to the MaxMind ASN database, e.g., ``/etc/GeoLite2-ASN.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
 When this is defined, the ASN information will always be fetched from the ``asn_db``.
      string asn_db_path = 2 [(.validate.rules) = { ... }
      Specified by:
      getAsnDbPath in interface MaxMindConfigOrBuilder
      Returns:
      The asnDbPath.

    • getAsnDbPathBytes

      public com.google.protobuf.ByteString getAsnDbPathBytes()
       Full file path to the MaxMind ASN database, e.g., ``/etc/GeoLite2-ASN.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
 When this is defined, the ASN information will always be fetched from the ``asn_db``.
      string asn_db_path = 2 [(.validate.rules) = { ... }
      Specified by:
      getAsnDbPathBytes in interface MaxMindConfigOrBuilder
      Returns:
      The bytes for asnDbPath.

    • getAnonDbPath

      public String getAnonDbPath()
       Full file path to the MaxMind Anonymous IP database, e.g., ``/etc/GeoIP2-Anonymous-IP.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
      string anon_db_path = 3 [(.validate.rules) = { ... }
      Specified by:
      getAnonDbPath in interface MaxMindConfigOrBuilder
      Returns:
      The anonDbPath.

    • getAnonDbPathBytes

      public com.google.protobuf.ByteString getAnonDbPathBytes()
       Full file path to the MaxMind Anonymous IP database, e.g., ``/etc/GeoIP2-Anonymous-IP.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
      string anon_db_path = 3 [(.validate.rules) = { ... }
      Specified by:
      getAnonDbPathBytes in interface MaxMindConfigOrBuilder
      Returns:
      The bytes for anonDbPath.

    • getIspDbPath

      public String getIspDbPath()
       Full file path to the MaxMind ISP database, e.g., ``/etc/GeoLite2-ISP.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
 If ``asn_db_path`` is not defined, ASN information will be fetched from
 ``isp_db`` instead.
      string isp_db_path = 5 [(.validate.rules) = { ... }
      Specified by:
      getIspDbPath in interface MaxMindConfigOrBuilder
      Returns:
      The ispDbPath.

    • getIspDbPathBytes

      public com.google.protobuf.ByteString getIspDbPathBytes()
       Full file path to the MaxMind ISP database, e.g., ``/etc/GeoLite2-ISP.mmdb``.
 Database file is expected to have ``.mmdb`` extension.
 If ``asn_db_path`` is not defined, ASN information will be fetched from
 ``isp_db`` instead.
      string isp_db_path = 5 [(.validate.rules) = { ... }
      Specified by:
      getIspDbPathBytes in interface MaxMindConfigOrBuilder
      Returns:
      The bytes for ispDbPath.

    • getCountryDbPath

      public String getCountryDbPath()
       Full file path to the MaxMind Country database, e.g., ``/etc/GeoLite2-Country.mmdb``.
 Database file is expected to have ``.mmdb`` extension.

 If ``country_db_path`` is not specified, country information will be fetched from
 ``city_db`` if ``city_db`` is configured.
      string country_db_path = 6 [(.validate.rules) = { ... }
      Specified by:
      getCountryDbPath in interface MaxMindConfigOrBuilder
      Returns:
      The countryDbPath.

    • getCountryDbPathBytes

      public com.google.protobuf.ByteString getCountryDbPathBytes()
       Full file path to the MaxMind Country database, e.g., ``/etc/GeoLite2-Country.mmdb``.
 Database file is expected to have ``.mmdb`` extension.

 If ``country_db_path`` is not specified, country information will be fetched from
 ``city_db`` if ``city_db`` is configured.
      string country_db_path = 6 [(.validate.rules) = { ... }
      Specified by:
      getCountryDbPathBytes in interface MaxMindConfigOrBuilder
      Returns:
      The bytes for countryDbPath.

    • hasCommonProviderConfig

      public boolean hasCommonProviderConfig()
       Common provider configuration that specifies which geolocation headers will be populated with geolocation data.
      .envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig common_provider_config = 4 [(.validate.rules) = { ... }
      Specified by:
      hasCommonProviderConfig in interface MaxMindConfigOrBuilder
      Returns:
      Whether the commonProviderConfig field is set.

    • getCommonProviderConfig

      public CommonGeoipProviderConfig getCommonProviderConfig()
       Common provider configuration that specifies which geolocation headers will be populated with geolocation data.
      .envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig common_provider_config = 4 [(.validate.rules) = { ... }
      Specified by:
      getCommonProviderConfig in interface MaxMindConfigOrBuilder
      Returns:
      The commonProviderConfig.

    • getCommonProviderConfigOrBuilder

      public CommonGeoipProviderConfigOrBuilder getCommonProviderConfigOrBuilder()
       Common provider configuration that specifies which geolocation headers will be populated with geolocation data.
      .envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig common_provider_config = 4 [(.validate.rules) = { ... }
      Specified by:
      getCommonProviderConfigOrBuilder in interface MaxMindConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MaxMindConfig.Builder newBuilder()

    • newBuilder

      public static MaxMindConfig.Builder newBuilder(MaxMindConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static MaxMindConfig getDefaultInstance()

    • parser

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

    • getParserForType

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