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

Interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAnonHosting()
      If set, the IP address will be checked if it belongs to a hosting provider and header will be populated with the check result.
      com.google.protobuf.ByteString getAnonHostingBytes()
      If set, the IP address will be checked if it belongs to a hosting provider and header will be populated with the check result.
      String getAnonProxy()
      If set, the IP address will be checked if it belongs to a public proxy and header will be populated with the check result.
      com.google.protobuf.ByteString getAnonProxyBytes()
      If set, the IP address will be checked if it belongs to a public proxy and header will be populated with the check result.
      String getAnonTor()
      If set, the IP address will be checked if it belongs to a TOR exit node and header will be populated with the check result.
      com.google.protobuf.ByteString getAnonTorBytes()
      If set, the IP address will be checked if it belongs to a TOR exit node and header will be populated with the check result.
      String getAnonVpn()
      If set, the IP address will be checked if it belongs to a VPN and header will be populated with the check result.
      com.google.protobuf.ByteString getAnonVpnBytes()
      If set, the IP address will be checked if it belongs to a VPN and header will be populated with the check result.
      String getAsn()
      If set, the header will be used to populate the ASN associated with the IP address.
      com.google.protobuf.ByteString getAsnBytes()
      If set, the header will be used to populate the ASN associated with the IP address.
      String getCity()
      If set, the header will be used to populate the city associated with the IP address.
      com.google.protobuf.ByteString getCityBytes()
      If set, the header will be used to populate the city associated with the IP address.
      String getCountry()
      If set, the header will be used to populate the country ISO code associated with the IP address.
      com.google.protobuf.ByteString getCountryBytes()
      If set, the header will be used to populate the country ISO code associated with the IP address.
      String getIsAnon()
      If set, the IP address will be checked if it belongs to any type of anonymization network (e.g.
      com.google.protobuf.ByteString getIsAnonBytes()
      If set, the IP address will be checked if it belongs to any type of anonymization network (e.g.
      String getRegion()
      If set, the header will be used to populate the region ISO code associated with the IP address.
      com.google.protobuf.ByteString getRegionBytes()
      If set, the header will be used to populate the region ISO code associated with the IP address.

      • 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 Detail

      • getCountry

        String getCountry()
         If set, the header will be used to populate the country ISO code associated with the IP address.
        string country = 1 [(.validate.rules) = { ... }
        Returns:
        The country.

      • getCountryBytes

        com.google.protobuf.ByteString getCountryBytes()
         If set, the header will be used to populate the country ISO code associated with the IP address.
        string country = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for country.

      • getCity

        String getCity()
         If set, the header will be used to populate the city associated with the IP address.
        string city = 2 [(.validate.rules) = { ... }
        Returns:
        The city.

      • getCityBytes

        com.google.protobuf.ByteString getCityBytes()
         If set, the header will be used to populate the city associated with the IP address.
        string city = 2 [(.validate.rules) = { ... }
        Returns:
        The bytes for city.

      • getRegion

        String getRegion()
         If set, the header will be used to populate the region ISO code associated with the IP address.
 The least specific subdivision will be selected as region value.
        string region = 3 [(.validate.rules) = { ... }
        Returns:
        The region.

      • getRegionBytes

        com.google.protobuf.ByteString getRegionBytes()
         If set, the header will be used to populate the region ISO code associated with the IP address.
 The least specific subdivision will be selected as region value.
        string region = 3 [(.validate.rules) = { ... }
        Returns:
        The bytes for region.

      • getAsn

        String getAsn()
         If set, the header will be used to populate the ASN associated with the IP address.
        string asn = 4 [(.validate.rules) = { ... }
        Returns:
        The asn.

      • getAsnBytes

        com.google.protobuf.ByteString getAsnBytes()
         If set, the header will be used to populate the ASN associated with the IP address.
        string asn = 4 [(.validate.rules) = { ... }
        Returns:
        The bytes for asn.

      • getIsAnon

        String getIsAnon()
         If set, the IP address will be checked if it belongs to any type of anonymization network (e.g. VPN, public proxy etc)
 and header will be populated with the check result. Header value will be set to either "true" or "false" depending on the check result.
        string is_anon = 5 [(.validate.rules) = { ... }
        Returns:
        The isAnon.

      • getIsAnonBytes

        com.google.protobuf.ByteString getIsAnonBytes()
         If set, the IP address will be checked if it belongs to any type of anonymization network (e.g. VPN, public proxy etc)
 and header will be populated with the check result. Header value will be set to either "true" or "false" depending on the check result.
        string is_anon = 5 [(.validate.rules) = { ... }
        Returns:
        The bytes for isAnon.

      • getAnonVpn

        String getAnonVpn()
         If set, the IP address will be checked if it belongs to a VPN and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_vpn = 6 [(.validate.rules) = { ... }
        Returns:
        The anonVpn.

      • getAnonVpnBytes

        com.google.protobuf.ByteString getAnonVpnBytes()
         If set, the IP address will be checked if it belongs to a VPN and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_vpn = 6 [(.validate.rules) = { ... }
        Returns:
        The bytes for anonVpn.

      • getAnonHosting

        String getAnonHosting()
         If set, the IP address will be checked if it belongs to a hosting provider and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_hosting = 7 [(.validate.rules) = { ... }
        Returns:
        The anonHosting.

      • getAnonHostingBytes

        com.google.protobuf.ByteString getAnonHostingBytes()
         If set, the IP address will be checked if it belongs to a hosting provider and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_hosting = 7 [(.validate.rules) = { ... }
        Returns:
        The bytes for anonHosting.

      • getAnonTor

        String getAnonTor()
         If set, the IP address will be checked if it belongs to a TOR exit node and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_tor = 8 [(.validate.rules) = { ... }
        Returns:
        The anonTor.

      • getAnonTorBytes

        com.google.protobuf.ByteString getAnonTorBytes()
         If set, the IP address will be checked if it belongs to a TOR exit node and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_tor = 8 [(.validate.rules) = { ... }
        Returns:
        The bytes for anonTor.

      • getAnonProxy

        String getAnonProxy()
         If set, the IP address will be checked if it belongs to a public proxy and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_proxy = 9 [(.validate.rules) = { ... }
        Returns:
        The anonProxy.

      • getAnonProxyBytes

        com.google.protobuf.ByteString getAnonProxyBytes()
         If set, the IP address will be checked if it belongs to a public proxy and header will be populated with the check result.
 Header value will be set to either "true" or "false" depending on the check result.
        string anon_proxy = 9 [(.validate.rules) = { ... }
        Returns:
        The bytes for anonProxy.