Package io.envoyproxy.envoy.extensions.filters.udp.dns_filter.v3

Interface DnsFilterConfig.ClientContextConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DnsFilterConfig.ClientContextConfig, DnsFilterConfig.ClientContextConfig.Builder
Enclosing class:
DnsFilterConfig
public static interface DnsFilterConfig.ClientContextConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasResolverTimeout

      boolean hasResolverTimeout()
       Sets the maximum time we will wait for the upstream query to complete
 We allow 5s for the upstream resolution to complete, so the minimum
 value here is 1. Note that the total latency for a failed query is the
 number of retries multiplied by the resolver_timeout.
      .google.protobuf.Duration resolver_timeout = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the resolverTimeout field is set.

    • getResolverTimeout

      com.google.protobuf.Duration getResolverTimeout()
       Sets the maximum time we will wait for the upstream query to complete
 We allow 5s for the upstream resolution to complete, so the minimum
 value here is 1. Note that the total latency for a failed query is the
 number of retries multiplied by the resolver_timeout.
      .google.protobuf.Duration resolver_timeout = 1 [(.validate.rules) = { ... }
      Returns:
      The resolverTimeout.

    • getResolverTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getResolverTimeoutOrBuilder()
       Sets the maximum time we will wait for the upstream query to complete
 We allow 5s for the upstream resolution to complete, so the minimum
 value here is 1. Note that the total latency for a failed query is the
 number of retries multiplied by the resolver_timeout.
      .google.protobuf.Duration resolver_timeout = 1 [(.validate.rules) = { ... }

    • getUpstreamResolversList

      @Deprecated List<Address> getUpstreamResolversList()
      Deprecated.
       This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.

 [#not-implemented-hide:]
      repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • getUpstreamResolvers

      @Deprecated Address getUpstreamResolvers(int index)
      Deprecated.
       This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.

 [#not-implemented-hide:]
      repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • getUpstreamResolversCount

      @Deprecated int getUpstreamResolversCount()
      Deprecated.
       This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.

 [#not-implemented-hide:]
      repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • getUpstreamResolversOrBuilderList

      @Deprecated List<? extends AddressOrBuilder> getUpstreamResolversOrBuilderList()
      Deprecated.
       This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.

 [#not-implemented-hide:]
      repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • getUpstreamResolversOrBuilder

      @Deprecated AddressOrBuilder getUpstreamResolversOrBuilder(int index)
      Deprecated.
       This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.

 [#not-implemented-hide:]
      repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • hasDnsResolutionConfig

      @Deprecated boolean hasDnsResolutionConfig()
      Deprecated.
      envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.dns_resolution_config is deprecated. See envoy/extensions/filters/udp/dns_filter/v3/dns_filter.proto;l=74
       DNS resolution configuration which includes the underlying dns resolver addresses and options.
 This field is deprecated in favor of
 :ref:`typed_dns_resolver_config <envoy_v3_api_field_extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.typed_dns_resolver_config>`.
      .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the dnsResolutionConfig field is set.

    • getDnsResolutionConfig

      @Deprecated DnsResolutionConfig getDnsResolutionConfig()
      Deprecated.
      envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.dns_resolution_config is deprecated. See envoy/extensions/filters/udp/dns_filter/v3/dns_filter.proto;l=74
       DNS resolution configuration which includes the underlying dns resolver addresses and options.
 This field is deprecated in favor of
 :ref:`typed_dns_resolver_config <envoy_v3_api_field_extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.typed_dns_resolver_config>`.
      .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The dnsResolutionConfig.

    • getDnsResolutionConfigOrBuilder

      @Deprecated DnsResolutionConfigOrBuilder getDnsResolutionConfigOrBuilder()
      Deprecated.
       DNS resolution configuration which includes the underlying dns resolver addresses and options.
 This field is deprecated in favor of
 :ref:`typed_dns_resolver_config <envoy_v3_api_field_extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.typed_dns_resolver_config>`.
      .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • hasTypedDnsResolverConfig

      boolean hasTypedDnsResolverConfig()
       DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
 or any other DNS resolver types and the related parameters.
 For example, an object of
 :ref:`CaresDnsResolverConfig <envoy_v3_api_msg_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig>`
 can be packed into this ``typed_dns_resolver_config``. This configuration replaces the
 :ref:`dns_resolution_config <envoy_v3_api_field_extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.dns_resolution_config>`
 configuration.
 During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
 when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
 When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
 [#extension-category: envoy.network.dns_resolver]
      .envoy.config.core.v3.TypedExtensionConfig typed_dns_resolver_config = 4;
      Returns:
      Whether the typedDnsResolverConfig field is set.

    • getTypedDnsResolverConfig

      TypedExtensionConfig getTypedDnsResolverConfig()
       DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
 or any other DNS resolver types and the related parameters.
 For example, an object of
 :ref:`CaresDnsResolverConfig <envoy_v3_api_msg_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig>`
 can be packed into this ``typed_dns_resolver_config``. This configuration replaces the
 :ref:`dns_resolution_config <envoy_v3_api_field_extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.dns_resolution_config>`
 configuration.
 During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
 when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
 When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
 [#extension-category: envoy.network.dns_resolver]
      .envoy.config.core.v3.TypedExtensionConfig typed_dns_resolver_config = 4;
      Returns:
      The typedDnsResolverConfig.

    • getTypedDnsResolverConfigOrBuilder

      TypedExtensionConfigOrBuilder getTypedDnsResolverConfigOrBuilder()
       DNS resolver type configuration extension. This extension can be used to configure c-ares, apple,
 or any other DNS resolver types and the related parameters.
 For example, an object of
 :ref:`CaresDnsResolverConfig <envoy_v3_api_msg_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig>`
 can be packed into this ``typed_dns_resolver_config``. This configuration replaces the
 :ref:`dns_resolution_config <envoy_v3_api_field_extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.dns_resolution_config>`
 configuration.
 During the transition period when both ``dns_resolution_config`` and ``typed_dns_resolver_config`` exists,
 when ``typed_dns_resolver_config`` is in place, Envoy will use it and ignore ``dns_resolution_config``.
 When ``typed_dns_resolver_config`` is missing, the default behavior is in place.
 [#extension-category: envoy.network.dns_resolver]
      .envoy.config.core.v3.TypedExtensionConfig typed_dns_resolver_config = 4;

    • getMaxPendingLookups

      long getMaxPendingLookups()
       Controls how many outstanding external lookup contexts the filter tracks.
 The context structure allows the filter to respond to every query even if the external
 resolution times out or is otherwise unsuccessful
      uint64 max_pending_lookups = 3 [(.validate.rules) = { ... }
      Returns:
      The maxPendingLookups.