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

Class CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder

    • Method Detail

      • 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.Builder<CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder>

      • getDefaultInstanceForType

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • buildPartial

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

      • setCountry

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setCountry​(String value)
         If set, the header will be used to populate the country ISO code associated with the IP address.
        string country = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The country to set.
        Returns:
        This builder for chaining.

      • setCountryBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setCountryBytes​(com.google.protobuf.ByteString value)
         If set, the header will be used to populate the country ISO code associated with the IP address.
        string country = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for country to set.
        Returns:
        This builder for chaining.

      • setCityBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setCityBytes​(com.google.protobuf.ByteString value)
         If set, the header will be used to populate the city associated with the IP address.
        string city = 2 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for city to set.
        Returns:
        This builder for chaining.

      • 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 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 region value.
        string region = 3 [(.validate.rules) = { ... }
        Specified by:
        getRegionBytes in interface CommonGeoipProviderConfig.GeolocationHeadersToAddOrBuilder
        Returns:
        The bytes for region.

      • setRegion

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setRegion​(String value)
         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) = { ... }
        Parameters:
        value - The region to set.
        Returns:
        This builder for chaining.

      • clearRegion

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder clearRegion()
         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:
        This builder for chaining.

      • setRegionBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setRegionBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for region to set.
        Returns:
        This builder for chaining.

      • setAsnBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAsnBytes​(com.google.protobuf.ByteString value)
         If set, the header will be used to populate the ASN associated with the IP address.
        string asn = 4 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for asn to set.
        Returns:
        This builder for chaining.

      • getIsAnon

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

      • getIsAnonBytes

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

      • setIsAnon

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setIsAnon​(String value)
         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) = { ... }
        Parameters:
        value - The isAnon to set.
        Returns:
        This builder for chaining.

      • clearIsAnon

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder clearIsAnon()
         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:
        This builder for chaining.

      • setIsAnonBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setIsAnonBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for isAnon to set.
        Returns:
        This builder for chaining.

      • getAnonVpn

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

      • setAnonVpn

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonVpn​(String value)
         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) = { ... }
        Parameters:
        value - The anonVpn to set.
        Returns:
        This builder for chaining.

      • clearAnonVpn

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder clearAnonVpn()
         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:
        This builder for chaining.

      • setAnonVpnBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonVpnBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for anonVpn to set.
        Returns:
        This builder for chaining.

      • getAnonHosting

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

      • setAnonHosting

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonHosting​(String value)
         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) = { ... }
        Parameters:
        value - The anonHosting to set.
        Returns:
        This builder for chaining.

      • clearAnonHosting

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder clearAnonHosting()
         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:
        This builder for chaining.

      • setAnonHostingBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonHostingBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for anonHosting to set.
        Returns:
        This builder for chaining.

      • getAnonTor

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

      • setAnonTor

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonTor​(String value)
         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) = { ... }
        Parameters:
        value - The anonTor to set.
        Returns:
        This builder for chaining.

      • clearAnonTor

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder clearAnonTor()
         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:
        This builder for chaining.

      • setAnonTorBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonTorBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for anonTor to set.
        Returns:
        This builder for chaining.

      • getAnonProxy

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

      • setAnonProxy

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonProxy​(String value)
         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) = { ... }
        Parameters:
        value - The anonProxy to set.
        Returns:
        This builder for chaining.

      • clearAnonProxy

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder clearAnonProxy()
         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:
        This builder for chaining.

      • setAnonProxyBytes

        public CommonGeoipProviderConfig.GeolocationHeadersToAdd.Builder setAnonProxyBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for anonProxy to set.
        Returns:
        This builder for chaining.