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

Class CommonGeoipProviderConfig.GeolocationHeadersToAdd

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder, Serializable
Enclosing class:
CommonGeoipProviderConfig
public static final class CommonGeoipProviderConfig.GeolocationHeadersToAdd extends com.google.protobuf.GeneratedMessageV3 implements CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
 The set of geolocation headers to add to request. If any of the configured headers is present
 in the incoming request, it will be overridden by the :ref:`HTTP GeoIP filter <config_http_filters_geoip>`.
 [#next-free-field: 13]

 .. attention::
   This field is deprecated in favor of :ref:`geo_field_keys
   <envoy_v3_api_field_extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.geo_field_keys>`.
Protobuf type envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationHeadersToAdd
See Also:

  • Field Details

  • 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

    • getCountry

      public 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) = { ... }
      Specified by:
      getCountry in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The country.

    • getCountryBytes

      public 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) = { ... }
      Specified by:
      getCountryBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for country.

    • getCity

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

    • getCityBytes

      public 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) = { ... }
      Specified by:
      getCityBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for city.

    • getRegion

      public 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) = { ... }
      Specified by:
      getRegion in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The region.

    • getRegionBytes

      public 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) = { ... }
      Specified by:
      getRegionBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for region.

    • getAsn

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

    • getAsnBytes

      public 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) = { ... }
      Specified by:
      getAsnBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for asn.

    • getIsAnon

      @Deprecated public 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) = { ... }
      Specified by:
      getIsAnon in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The isAnon.

    • getIsAnonBytes

      @Deprecated public 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) = { ... }
      Specified by:
      getIsAnonBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for isAnon.

    • getAnon

      public 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) = { ... }
      Specified by:
      getAnon in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The anon.

    • getAnonBytes

      public 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) = { ... }
      Specified by:
      getAnonBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for anon.

    • getAnonVpn

      public 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) = { ... }
      Specified by:
      getAnonVpn in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The anonVpn.

    • getAnonVpnBytes

      public 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) = { ... }
      Specified by:
      getAnonVpnBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for anonVpn.

    • getAnonHosting

      public 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) = { ... }
      Specified by:
      getAnonHosting in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The anonHosting.

    • getAnonHostingBytes

      public 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) = { ... }
      Specified by:
      getAnonHostingBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for anonHosting.

    • getAnonTor

      public 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) = { ... }
      Specified by:
      getAnonTor in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The anonTor.

    • getAnonTorBytes

      public 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) = { ... }
      Specified by:
      getAnonTorBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for anonTor.

    • getAnonProxy

      public 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) = { ... }
      Specified by:
      getAnonProxy in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The anonProxy.

    • getAnonProxyBytes

      public 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) = { ... }
      Specified by:
      getAnonProxyBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for anonProxy.

    • getIsp

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

    • getIspBytes

      public 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) = { ... }
      Specified by:
      getIspBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for isp.

    • getApplePrivateRelay

      public 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) = { ... }
      Specified by:
      getApplePrivateRelay in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The applePrivateRelay.

    • getApplePrivateRelayBytes

      public 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) = { ... }
      Specified by:
      getApplePrivateRelayBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
      Returns:
      The bytes for applePrivateRelay.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static CommonGeoipProviderConfig.GeolocationHeadersToAdd parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static CommonGeoipProviderConfig.GeolocationHeadersToAdd parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder newBuilder()

    • newBuilder

      public static CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder newBuilder(CommonGeoipProviderConfig.GeolocationHeadersToAdd prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CommonGeoipProviderConfig.GeolocationHeadersToAdd getDefaultInstance()

    • parser

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

    • getParserForType

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