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

Interface GeoipOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Geoip, Geoip.Builder
public interface GeoipOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Geoip.CustomHeaderConfig
    getCustomHeaderConfig()
    Configuration for extracting the client IP address from a custom request header.
    Geoip.CustomHeaderConfigOrBuilder
    getCustomHeaderConfigOrBuilder()
    Configuration for extracting the client IP address from a custom request header.
    TypedExtensionConfig
    getProvider()
    Geoip driver specific configuration which depends on the driver being instantiated.
    TypedExtensionConfigOrBuilder
    getProviderOrBuilder()
    Geoip driver specific configuration which depends on the driver being instantiated.
    Geoip.XffConfig
    getXffConfig()
    Configuration for extracting the client IP address from the ``x-forwarded-for`` header.
    Geoip.XffConfigOrBuilder
    getXffConfigOrBuilder()
    Configuration for extracting the client IP address from the ``x-forwarded-for`` header.
    boolean
    hasCustomHeaderConfig()
    Configuration for extracting the client IP address from a custom request header.
    boolean
    hasProvider()
    Geoip driver specific configuration which depends on the driver being instantiated.
    boolean
    hasXffConfig()
    Configuration for extracting the client IP address from the ``x-forwarded-for`` header.

    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

    • hasXffConfig

      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;
      Returns:
      Whether the xffConfig field is set.

    • getXffConfig

      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;
      Returns:
      The xffConfig.

    • getXffConfigOrBuilder

      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;

    • hasCustomHeaderConfig

      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;
      Returns:
      Whether the customHeaderConfig field is set.

    • getCustomHeaderConfig

      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;
      Returns:
      The customHeaderConfig.

    • getCustomHeaderConfigOrBuilder

      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;

    • hasProvider

      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) = { ... }
      Returns:
      Whether the provider field is set.

    • getProvider

      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) = { ... }
      Returns:
      The provider.

    • getProviderOrBuilder

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