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
    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()
    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 trusted client address from ``x-forwarded-for`` header.
    Geoip.XffConfigOrBuilder
    getXffConfigOrBuilder()
    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 trusted client address from ``x-forwarded-for`` header.
    boolean
    hasProvider()
    Geoip driver specific configuration which depends on the driver being instantiated.
    boolean
    hasXffConfig()
    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 trusted client address from ``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()
       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
 trusted client address from ``x-forwarded-for`` header.
 Otherwise, the immediate downstream connection source address will be used.
 [#next-free-field: 2]
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Returns:
      Whether the xffConfig field is set.

    • getXffConfig

      Geoip.XffConfig getXffConfig()
       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
 trusted client address from ``x-forwarded-for`` header.
 Otherwise, the immediate downstream connection source address will be used.
 [#next-free-field: 2]
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;
      Returns:
      The xffConfig.

    • getXffConfigOrBuilder

      Geoip.XffConfigOrBuilder getXffConfigOrBuilder()
       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
 trusted client address from ``x-forwarded-for`` header.
 Otherwise, the immediate downstream connection source address will be used.
 [#next-free-field: 2]
      .envoy.extensions.filters.http.geoip.v3.Geoip.XffConfig xff_config = 1;

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