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

Interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CommonGeoipProviderConfig.GeolocationHeadersToAdd, CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder
Enclosing class:
CommonGeoipProviderConfig
public static interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAnon()
    If set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy).
    com.google.protobuf.ByteString
    getAnonBytes()
    If set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy).
    String
    getAnonHosting()
    If set, the IP address will be checked if it belongs to a hosting provider and the 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 the 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 the 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 the 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 the 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 the 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 the 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 the header will be populated with the check result.
    String
    getApplePrivateRelay()
    If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the header will be populated with the check result.
    com.google.protobuf.ByteString
    getApplePrivateRelayBytes()
    If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the 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()
    Deprecated.
    envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd.is_anon is deprecated.
    com.google.protobuf.ByteString
    getIsAnonBytes()
    Deprecated.
    envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd.is_anon is deprecated.
    String
    getIsp()
    If set, the header will be used to populate the ISP associated with the IP address.
    com.google.protobuf.ByteString
    getIspBytes()
    If set, the header will be used to populate the ISP associated with the IP address.
    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 Details

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

      @Deprecated String getIsAnon()
      Deprecated.
      envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd.is_anon is deprecated. See envoy/extensions/geoip_providers/common/v3/common.proto;l=45
       This field is deprecated; use ``anon`` instead.
      string is_anon = 5 [deprecated = true, (.validate.rules) = { ... }
      Returns:
      The isAnon.

    • getIsAnonBytes

      @Deprecated com.google.protobuf.ByteString getIsAnonBytes()
      Deprecated.
      envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd.is_anon is deprecated. See envoy/extensions/geoip_providers/common/v3/common.proto;l=45
       This field is deprecated; use ``anon`` instead.
      string is_anon = 5 [deprecated = true, (.validate.rules) = { ... }
      Returns:
      The bytes for isAnon.

    • getAnon

      String getAnon()
       If set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy).
 The 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 = 12 [(.validate.rules) = { ... }
      Returns:
      The anon.

    • getAnonBytes

      com.google.protobuf.ByteString getAnonBytes()
       If set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy).
 The 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 = 12 [(.validate.rules) = { ... }
      Returns:
      The bytes for anon.

    • getAnonVpn

      String getAnonVpn()
       If set, the IP address will be checked if it belongs to a VPN and the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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.

    • getIsp

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

    • getIspBytes

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

    • getApplePrivateRelay

      String getApplePrivateRelay()
       If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the header will be populated with the check result.
 Header value will be set to either ``true`` or ``false`` depending on the check result.
      string apple_private_relay = 11 [(.validate.rules) = { ... }
      Returns:
      The applePrivateRelay.

    • getApplePrivateRelayBytes

      com.google.protobuf.ByteString getApplePrivateRelayBytes()
       If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the header will be populated with the check result.
 Header value will be set to either ``true`` or ``false`` depending on the check result.
      string apple_private_relay = 11 [(.validate.rules) = { ... }
      Returns:
      The bytes for applePrivateRelay.