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

Interface MaxMindConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MaxMindConfig, MaxMindConfig.Builder
public interface MaxMindConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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``.
    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``.
    boolean
    hasCommonProviderConfig()
    Common provider configuration that specifies which geolocation headers will be populated with geolocation data.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getCityDbPath

      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) = { ... }
      Returns:
      The cityDbPath.

    • getCityDbPathBytes

      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) = { ... }
      Returns:
      The bytes for cityDbPath.

    • getAsnDbPath

      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) = { ... }
      Returns:
      The asnDbPath.

    • getAsnDbPathBytes

      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) = { ... }
      Returns:
      The bytes for asnDbPath.

    • getAnonDbPath

      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) = { ... }
      Returns:
      The anonDbPath.

    • getAnonDbPathBytes

      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) = { ... }
      Returns:
      The bytes for anonDbPath.

    • getIspDbPath

      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) = { ... }
      Returns:
      The ispDbPath.

    • getIspDbPathBytes

      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) = { ... }
      Returns:
      The bytes for ispDbPath.

    • getCountryDbPath

      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) = { ... }
      Returns:
      The countryDbPath.

    • getCountryDbPathBytes

      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) = { ... }
      Returns:
      The bytes for countryDbPath.

    • hasCommonProviderConfig

      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) = { ... }
      Returns:
      Whether the commonProviderConfig field is set.

    • getCommonProviderConfig

      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) = { ... }
      Returns:
      The commonProviderConfig.

    • getCommonProviderConfigOrBuilder

      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) = { ... }