Class CommonGeoipProviderConfig.GeolocationFieldKeys
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationFieldKeys
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,CommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder,Serializable
- Enclosing class:
- CommonGeoipProviderConfig
public static final class CommonGeoipProviderConfig.GeolocationFieldKeys
extends com.google.protobuf.GeneratedMessageV3
implements CommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder
The set of geolocation field keys to use for storing lookup results. These keys define how the geolocation lookup results will be stored. The actual storage mechanism depends on the filter using the provider: - The :ref:`HTTP GeoIP filter <config_http_filters_geoip>` stores results as HTTP request headers. - The :ref:`Network GeoIP filter <config_network_filters_geoip>` stores results in the connection's filter state under the well-known key ``envoy.geoip``. [#next-free-field: 12]Protobuf type
envoy.extensions.geoip_providers.common.v3.CommonGeoipProviderConfig.GeolocationFieldKeys- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classThe set of geolocation field keys to use for storing lookup results.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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAnon()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.ByteStringIf set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy).If set, the IP address will be checked if it belongs to a hosting provider and the result will be stored with this key.com.google.protobuf.ByteStringIf set, the IP address will be checked if it belongs to a hosting provider and the result will be stored with this key.If set, the IP address will be checked if it belongs to a public proxy and the result will be stored with this key.com.google.protobuf.ByteStringIf set, the IP address will be checked if it belongs to a public proxy and the result will be stored with this key.If set, the IP address will be checked if it belongs to a TOR exit node and the result will be stored with this key.com.google.protobuf.ByteStringIf set, the IP address will be checked if it belongs to a TOR exit node and the result will be stored with this key.If set, the IP address will be checked if it belongs to a VPN and the result will be stored with this key.com.google.protobuf.ByteStringIf set, the IP address will be checked if it belongs to a VPN and the result will be stored with this key.If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the result will be stored with this key.com.google.protobuf.ByteStringIf set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the result will be stored with this key.getAsn()If set, the key will be used to populate the ASN associated with the IP address.com.google.protobuf.ByteStringIf set, the key will be used to populate the ASN associated with the IP address.getCity()If set, the key will be used to populate the city associated with the IP address.com.google.protobuf.ByteStringIf set, the key will be used to populate the city associated with the IP address.If set, the key will be used to populate the country ISO code associated with the IP address.com.google.protobuf.ByteStringIf set, the key will be used to populate the country ISO code associated with the IP address.static final com.google.protobuf.Descriptors.DescriptorgetIsp()If set, the key will be used to populate the ISP associated with the IP address.com.google.protobuf.ByteStringIf set, the key will be used to populate the ISP associated with the IP address.com.google.protobuf.Parser<CommonGeoipProviderConfig.GeolocationFieldKeys>If set, the key will be used to populate the region ISO code associated with the IP address.com.google.protobuf.ByteStringIf set, the key will be used to populate the region ISO code associated with the IP address.intinthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<CommonGeoipProviderConfig.GeolocationFieldKeys>parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
COUNTRY_FIELD_NUMBER
public static final int COUNTRY_FIELD_NUMBER- See Also:
-
CITY_FIELD_NUMBER
public static final int CITY_FIELD_NUMBER- See Also:
-
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER- See Also:
-
ASN_FIELD_NUMBER
public static final int ASN_FIELD_NUMBER- See Also:
-
ANON_FIELD_NUMBER
public static final int ANON_FIELD_NUMBER- See Also:
-
ANON_VPN_FIELD_NUMBER
public static final int ANON_VPN_FIELD_NUMBER- See Also:
-
ANON_HOSTING_FIELD_NUMBER
public static final int ANON_HOSTING_FIELD_NUMBER- See Also:
-
ANON_TOR_FIELD_NUMBER
public static final int ANON_TOR_FIELD_NUMBER- See Also:
-
ANON_PROXY_FIELD_NUMBER
public static final int ANON_PROXY_FIELD_NUMBER- See Also:
-
ISP_FIELD_NUMBER
public static final int ISP_FIELD_NUMBER- See Also:
-
APPLE_PRIVATE_RELAY_FIELD_NUMBER
public static final int APPLE_PRIVATE_RELAY_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getCountry
If set, the key will be used to populate the country ISO code associated with the IP address.
string country = 1;- Specified by:
getCountryin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The country.
-
getCountryBytes
public com.google.protobuf.ByteString getCountryBytes()If set, the key will be used to populate the country ISO code associated with the IP address.
string country = 1;- Specified by:
getCountryBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for country.
-
getCity
If set, the key will be used to populate the city associated with the IP address.
string city = 2;- Specified by:
getCityin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The city.
-
getCityBytes
public com.google.protobuf.ByteString getCityBytes()If set, the key will be used to populate the city associated with the IP address.
string city = 2;- Specified by:
getCityBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for city.
-
getRegion
If set, the key 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;- Specified by:
getRegionin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The region.
-
getRegionBytes
public com.google.protobuf.ByteString getRegionBytes()If set, the key 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;- Specified by:
getRegionBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for region.
-
getAsn
If set, the key will be used to populate the ASN associated with the IP address.
string asn = 4;- Specified by:
getAsnin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The asn.
-
getAsnBytes
public com.google.protobuf.ByteString getAsnBytes()If set, the key will be used to populate the ASN associated with the IP address.
string asn = 4;- Specified by:
getAsnBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for asn.
-
getAnon
If set, the IP address will be checked if it belongs to any type of anonymization network (e.g., VPN, public proxy). The result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon = 5;- Specified by:
getAnonin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- 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 result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon = 5;- Specified by:
getAnonBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for anon.
-
getAnonVpn
If set, the IP address will be checked if it belongs to a VPN and the result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_vpn = 6;- Specified by:
getAnonVpnin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- 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 result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_vpn = 6;- Specified by:
getAnonVpnBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for anonVpn.
-
getAnonHosting
If set, the IP address will be checked if it belongs to a hosting provider and the result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_hosting = 7;- Specified by:
getAnonHostingin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- 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 result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_hosting = 7;- Specified by:
getAnonHostingBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for anonHosting.
-
getAnonTor
If set, the IP address will be checked if it belongs to a TOR exit node and the result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_tor = 8;- Specified by:
getAnonTorin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- 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 result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_tor = 8;- Specified by:
getAnonTorBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for anonTor.
-
getAnonProxy
If set, the IP address will be checked if it belongs to a public proxy and the result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_proxy = 9;- Specified by:
getAnonProxyin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- 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 result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string anon_proxy = 9;- Specified by:
getAnonProxyBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for anonProxy.
-
getIsp
If set, the key will be used to populate the ISP associated with the IP address.
string isp = 10;- Specified by:
getIspin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The isp.
-
getIspBytes
public com.google.protobuf.ByteString getIspBytes()If set, the key will be used to populate the ISP associated with the IP address.
string isp = 10;- Specified by:
getIspBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for isp.
-
getApplePrivateRelay
If set, the IP address will be checked if it belongs to the ISP named iCloud Private Relay and the result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string apple_private_relay = 11;- Specified by:
getApplePrivateRelayin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- 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 result will be stored with this key. Value will be set to either ``true`` or ``false`` depending on the check result.
string apple_private_relay = 11;- Specified by:
getApplePrivateRelayBytesin interfaceCommonGeoipProviderConfig.GeolocationFieldKeysOrBuilder- Returns:
- The bytes for applePrivateRelay.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys 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.GeolocationFieldKeys parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static CommonGeoipProviderConfig.GeolocationFieldKeys parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static CommonGeoipProviderConfig.GeolocationFieldKeys.Builder newBuilder(CommonGeoipProviderConfig.GeolocationFieldKeys prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CommonGeoipProviderConfig.GeolocationFieldKeys.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
public com.google.protobuf.Parser<CommonGeoipProviderConfig.GeolocationFieldKeys> getParserForType()- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-