Package io.envoyproxy.envoy.extensions.filters.http.geoip.v3

Class Geoip.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>
io.envoyproxy.envoy.extensions.filters.http.geoip.v3.Geoip.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GeoipOrBuilder, Cloneable
Enclosing class:
Geoip
public static final class Geoip.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder> implements GeoipOrBuilder
Protobuf type envoy.extensions.filters.http.geoip.v3.Geoip

  • Method Details

    • 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<Geoip.Builder>

    • clear

      public Geoip.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.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<Geoip.Builder>

    • getDefaultInstanceForType

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

    • build

      public Geoip build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

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

    • clone

      public Geoip.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • setField

      public Geoip.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • clearField

      public Geoip.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • clearOneof

      public Geoip.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • setRepeatedField

      public Geoip.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • addRepeatedField

      public Geoip.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • mergeFrom

      public Geoip.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Geoip.Builder>

    • mergeFrom

      public Geoip.Builder mergeFrom(Geoip other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • mergeFrom

      public Geoip.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Geoip.Builder>
      Throws:
      IOException

    • hasXffConfig

      public boolean hasXffConfig()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Specified by:
      hasXffConfig in interface GeoipOrBuilder
      Returns:
      Whether the xffConfig field is set.

    • getXffConfig

      public Geoip.XffConfig getXffConfig()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Specified by:
      getXffConfig in interface GeoipOrBuilder
      Returns:
      The xffConfig.

    • setXffConfig

      public Geoip.Builder setXffConfig(Geoip.XffConfig value)
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;

    • setXffConfig

      public Geoip.Builder setXffConfig(Geoip.XffConfig.Builder builderForValue)
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;

    • mergeXffConfig

      public Geoip.Builder mergeXffConfig(Geoip.XffConfig value)
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;

    • clearXffConfig

      public Geoip.Builder clearXffConfig()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;

    • getXffConfigBuilder

      public Geoip.XffConfig.Builder getXffConfigBuilder()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;

    • getXffConfigOrBuilder

      public Geoip.XffConfigOrBuilder getXffConfigOrBuilder()
       Configuration for extracting the client IP address from the
 ``x-forwarded-for`` header. If set, the
 :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>`
 field will be used to determine the trusted client address from the ``x-forwarded-for`` header.
 If not set, the immediate downstream connection source address will be used.

 Only one of ``xff_config`` or
 :ref:`custom_header_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.custom_header_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Specified by:
      getXffConfigOrBuilder in interface GeoipOrBuilder

    • hasCustomHeaderConfig

      public boolean hasCustomHeaderConfig()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;
      Specified by:
      hasCustomHeaderConfig in interface GeoipOrBuilder
      Returns:
      Whether the customHeaderConfig field is set.

    • getCustomHeaderConfig

      public Geoip.CustomHeaderConfig getCustomHeaderConfig()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;
      Specified by:
      getCustomHeaderConfig in interface GeoipOrBuilder
      Returns:
      The customHeaderConfig.

    • setCustomHeaderConfig

      public Geoip.Builder setCustomHeaderConfig(Geoip.CustomHeaderConfig value)
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;

    • setCustomHeaderConfig

      public Geoip.Builder setCustomHeaderConfig(Geoip.CustomHeaderConfig.Builder builderForValue)
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;

    • mergeCustomHeaderConfig

      public Geoip.Builder mergeCustomHeaderConfig(Geoip.CustomHeaderConfig value)
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;

    • clearCustomHeaderConfig

      public Geoip.Builder clearCustomHeaderConfig()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;

    • getCustomHeaderConfigBuilder

      public Geoip.CustomHeaderConfig.Builder getCustomHeaderConfigBuilder()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;

    • getCustomHeaderConfigOrBuilder

      public Geoip.CustomHeaderConfigOrBuilder getCustomHeaderConfigOrBuilder()
       Configuration for extracting the client IP address from a custom request header.

 If set, the
 :ref:`header_name <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig.header_name>`
 field will be used to extract the client IP address from the specified request header.

 Only one of ``custom_header_config`` or
 :ref:`xff_config <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config>`
 can be set.
      .envoy.extensions.filters.http.geoip.v3.Geoip.CustomHeaderConfig custom_header_config = 4;
      Specified by:
      getCustomHeaderConfigOrBuilder in interface GeoipOrBuilder

    • hasProvider

      public boolean hasProvider()
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }
      Specified by:
      hasProvider in interface GeoipOrBuilder
      Returns:
      Whether the provider field is set.

    • getProvider

      public TypedExtensionConfig getProvider()
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }
      Specified by:
      getProvider in interface GeoipOrBuilder
      Returns:
      The provider.

    • setProvider

      public Geoip.Builder setProvider(TypedExtensionConfig value)
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }

    • setProvider

      public Geoip.Builder setProvider(TypedExtensionConfig.Builder builderForValue)
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }

    • mergeProvider

      public Geoip.Builder mergeProvider(TypedExtensionConfig value)
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }

    • clearProvider

      public Geoip.Builder clearProvider()
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }

    • getProviderBuilder

      public TypedExtensionConfig.Builder getProviderBuilder()
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }

    • getProviderOrBuilder

      public TypedExtensionConfigOrBuilder getProviderOrBuilder()
       Geoip driver specific configuration which depends on the driver being instantiated.
 See the geoip drivers for examples:

 - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`
 [#extension-category: envoy.geoip_providers]
      .envoy.config.core.v3.TypedExtensionConfig provider = 3 [(.validate.rules) = { ... }
      Specified by:
      getProviderOrBuilder in interface GeoipOrBuilder

    • setUnknownFields

      public final Geoip.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>

    • mergeUnknownFields

      public final Geoip.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Geoip.Builder>