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

Class DnsCacheConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DnsCacheConfigOrBuilder, Serializable
public final class DnsCacheConfig extends com.google.protobuf.GeneratedMessageV3 implements DnsCacheConfigOrBuilder
 Configuration for the dynamic forward proxy DNS cache. See the :ref:`architecture overview
 <arch_overview_http_dynamic_forward_proxy>` for more information.
 [#next-free-field: 16]
Protobuf type envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DNS_LOOKUP_FAMILY_FIELD_NUMBER

      public static final int DNS_LOOKUP_FAMILY_FIELD_NUMBER
      See Also:

    • DNS_REFRESH_RATE_FIELD_NUMBER

      public static final int DNS_REFRESH_RATE_FIELD_NUMBER
      See Also:

    • DNS_MIN_REFRESH_RATE_FIELD_NUMBER

      public static final int DNS_MIN_REFRESH_RATE_FIELD_NUMBER
      See Also:

    • HOST_TTL_FIELD_NUMBER

      public static final int HOST_TTL_FIELD_NUMBER
      See Also:

    • MAX_HOSTS_FIELD_NUMBER

      public static final int MAX_HOSTS_FIELD_NUMBER
      See Also:

    • DISABLE_DNS_REFRESH_ON_FAILURE_FIELD_NUMBER

      public static final int DISABLE_DNS_REFRESH_ON_FAILURE_FIELD_NUMBER
      See Also:

    • DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER

      public static final int DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER
      See Also:

    • DNS_CACHE_CIRCUIT_BREAKER_FIELD_NUMBER

      public static final int DNS_CACHE_CIRCUIT_BREAKER_FIELD_NUMBER
      See Also:

    • USE_TCP_FOR_DNS_LOOKUPS_FIELD_NUMBER

      public static final int USE_TCP_FOR_DNS_LOOKUPS_FIELD_NUMBER
      See Also:

    • DNS_RESOLUTION_CONFIG_FIELD_NUMBER

      public static final int DNS_RESOLUTION_CONFIG_FIELD_NUMBER
      See Also:

    • TYPED_DNS_RESOLVER_CONFIG_FIELD_NUMBER

      public static final int TYPED_DNS_RESOLVER_CONFIG_FIELD_NUMBER
      See Also:

    • PRERESOLVE_HOSTNAMES_FIELD_NUMBER

      public static final int PRERESOLVE_HOSTNAMES_FIELD_NUMBER
      See Also:

    • DNS_QUERY_TIMEOUT_FIELD_NUMBER

      public static final int DNS_QUERY_TIMEOUT_FIELD_NUMBER
      See Also:

    • KEY_VALUE_CONFIG_FIELD_NUMBER

      public static final int KEY_VALUE_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • getName

      public String getName()
       The name of the cache. Multiple named caches allow independent dynamic forward proxy
 configurations to operate within a single Envoy process using different configurations. All
 configurations with the same name *must* otherwise have the same settings when referenced
 from different configuration components. Configuration will fail to load if this is not
 the case.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getName in interface DnsCacheConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the cache. Multiple named caches allow independent dynamic forward proxy
 configurations to operate within a single Envoy process using different configurations. All
 configurations with the same name *must* otherwise have the same settings when referenced
 from different configuration components. Configuration will fail to load if this is not
 the case.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getNameBytes in interface DnsCacheConfigOrBuilder
      Returns:
      The bytes for name.

    • getDnsLookupFamilyValue

      public int getDnsLookupFamilyValue()
       The DNS lookup family to use during resolution.

 [#comment:TODO(mattklein123): Figure out how to support IPv4/IPv6 "happy eyeballs" mode. The
 way this might work is a new lookup family which returns both IPv4 and IPv6 addresses, and
 then configures a host to have a primary and fall back address. With this, we could very
 likely build a "happy eyeballs" connection pool which would race the primary / fall back
 address and return the one that wins. This same method could potentially also be used for
 QUIC to TCP fall back.]
      .envoy.config.cluster.v3.Cluster.DnsLookupFamily dns_lookup_family = 2 [(.validate.rules) = { ... }
      Specified by:
      getDnsLookupFamilyValue in interface DnsCacheConfigOrBuilder
      Returns:
      The enum numeric value on the wire for dnsLookupFamily.

    • getDnsLookupFamily

      public Cluster.DnsLookupFamily getDnsLookupFamily()
       The DNS lookup family to use during resolution.

 [#comment:TODO(mattklein123): Figure out how to support IPv4/IPv6 "happy eyeballs" mode. The
 way this might work is a new lookup family which returns both IPv4 and IPv6 addresses, and
 then configures a host to have a primary and fall back address. With this, we could very
 likely build a "happy eyeballs" connection pool which would race the primary / fall back
 address and return the one that wins. This same method could potentially also be used for
 QUIC to TCP fall back.]
      .envoy.config.cluster.v3.Cluster.DnsLookupFamily dns_lookup_family = 2 [(.validate.rules) = { ... }
      Specified by:
      getDnsLookupFamily in interface DnsCacheConfigOrBuilder
      Returns:
      The dnsLookupFamily.

    • hasDnsRefreshRate

      public boolean hasDnsRefreshRate()
       The DNS refresh rate for unresolved DNS hosts. If not specified defaults to 60s.

 The refresh rate is rounded to the closest millisecond, and must be at least 1ms.

 Once a host has been resolved, the refresh rate will be the DNS TTL, capped
 at a minimum of ``dns_min_refresh_rate``.
      .google.protobuf.Duration dns_refresh_rate = 3 [(.validate.rules) = { ... }
      Specified by:
      hasDnsRefreshRate in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the dnsRefreshRate field is set.

    • getDnsRefreshRate

      public com.google.protobuf.Duration getDnsRefreshRate()
       The DNS refresh rate for unresolved DNS hosts. If not specified defaults to 60s.

 The refresh rate is rounded to the closest millisecond, and must be at least 1ms.

 Once a host has been resolved, the refresh rate will be the DNS TTL, capped
 at a minimum of ``dns_min_refresh_rate``.
      .google.protobuf.Duration dns_refresh_rate = 3 [(.validate.rules) = { ... }
      Specified by:
      getDnsRefreshRate in interface DnsCacheConfigOrBuilder
      Returns:
      The dnsRefreshRate.

    • getDnsRefreshRateOrBuilder

      public com.google.protobuf.DurationOrBuilder getDnsRefreshRateOrBuilder()
       The DNS refresh rate for unresolved DNS hosts. If not specified defaults to 60s.

 The refresh rate is rounded to the closest millisecond, and must be at least 1ms.

 Once a host has been resolved, the refresh rate will be the DNS TTL, capped
 at a minimum of ``dns_min_refresh_rate``.
      .google.protobuf.Duration dns_refresh_rate = 3 [(.validate.rules) = { ... }
      Specified by:
      getDnsRefreshRateOrBuilder in interface DnsCacheConfigOrBuilder

    • hasDnsMinRefreshRate

      public boolean hasDnsMinRefreshRate()
       The minimum rate that DNS resolution will occur. Per ``dns_refresh_rate``, once a host is
 resolved, the DNS TTL will be used, with a minimum set by ``dns_min_refresh_rate``.
 ``dns_min_refresh_rate`` defaults to 5s and must also be >= 1s.
      .google.protobuf.Duration dns_min_refresh_rate = 14 [(.validate.rules) = { ... }
      Specified by:
      hasDnsMinRefreshRate in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the dnsMinRefreshRate field is set.

    • getDnsMinRefreshRate

      public com.google.protobuf.Duration getDnsMinRefreshRate()
       The minimum rate that DNS resolution will occur. Per ``dns_refresh_rate``, once a host is
 resolved, the DNS TTL will be used, with a minimum set by ``dns_min_refresh_rate``.
 ``dns_min_refresh_rate`` defaults to 5s and must also be >= 1s.
      .google.protobuf.Duration dns_min_refresh_rate = 14 [(.validate.rules) = { ... }
      Specified by:
      getDnsMinRefreshRate in interface DnsCacheConfigOrBuilder
      Returns:
      The dnsMinRefreshRate.

    • getDnsMinRefreshRateOrBuilder

      public com.google.protobuf.DurationOrBuilder getDnsMinRefreshRateOrBuilder()
       The minimum rate that DNS resolution will occur. Per ``dns_refresh_rate``, once a host is
 resolved, the DNS TTL will be used, with a minimum set by ``dns_min_refresh_rate``.
 ``dns_min_refresh_rate`` defaults to 5s and must also be >= 1s.
      .google.protobuf.Duration dns_min_refresh_rate = 14 [(.validate.rules) = { ... }
      Specified by:
      getDnsMinRefreshRateOrBuilder in interface DnsCacheConfigOrBuilder

    • hasHostTtl

      public boolean hasHostTtl()
       The TTL for hosts that are unused. Hosts that have not been used in the configured time
 interval will be purged. If not specified defaults to 5m.

 .. note:

   The TTL is only checked at the time of DNS refresh, as specified by ``dns_refresh_rate``. This
   means that if the configured TTL is shorter than the refresh rate the host may not be removed
   immediately.

  .. note:

   The TTL has no relation to DNS TTL and is only used to control Envoy's resource usage.
      .google.protobuf.Duration host_ttl = 4 [(.validate.rules) = { ... }
      Specified by:
      hasHostTtl in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the hostTtl field is set.

    • getHostTtl

      public com.google.protobuf.Duration getHostTtl()
       The TTL for hosts that are unused. Hosts that have not been used in the configured time
 interval will be purged. If not specified defaults to 5m.

 .. note:

   The TTL is only checked at the time of DNS refresh, as specified by ``dns_refresh_rate``. This
   means that if the configured TTL is shorter than the refresh rate the host may not be removed
   immediately.

  .. note:

   The TTL has no relation to DNS TTL and is only used to control Envoy's resource usage.
      .google.protobuf.Duration host_ttl = 4 [(.validate.rules) = { ... }
      Specified by:
      getHostTtl in interface DnsCacheConfigOrBuilder
      Returns:
      The hostTtl.

    • getHostTtlOrBuilder

      public com.google.protobuf.DurationOrBuilder getHostTtlOrBuilder()
       The TTL for hosts that are unused. Hosts that have not been used in the configured time
 interval will be purged. If not specified defaults to 5m.

 .. note:

   The TTL is only checked at the time of DNS refresh, as specified by ``dns_refresh_rate``. This
   means that if the configured TTL is shorter than the refresh rate the host may not be removed
   immediately.

  .. note:

   The TTL has no relation to DNS TTL and is only used to control Envoy's resource usage.
      .google.protobuf.Duration host_ttl = 4 [(.validate.rules) = { ... }
      Specified by:
      getHostTtlOrBuilder in interface DnsCacheConfigOrBuilder

    • hasMaxHosts

      public boolean hasMaxHosts()
       The maximum number of hosts that the cache will hold. If not specified defaults to 1024.

 .. note:

   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum hosts in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
      .google.protobuf.UInt32Value max_hosts = 5 [(.validate.rules) = { ... }
      Specified by:
      hasMaxHosts in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the maxHosts field is set.

    • getMaxHosts

      public com.google.protobuf.UInt32Value getMaxHosts()
       The maximum number of hosts that the cache will hold. If not specified defaults to 1024.

 .. note:

   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum hosts in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
      .google.protobuf.UInt32Value max_hosts = 5 [(.validate.rules) = { ... }
      Specified by:
      getMaxHosts in interface DnsCacheConfigOrBuilder
      Returns:
      The maxHosts.

    • getMaxHostsOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMaxHostsOrBuilder()
       The maximum number of hosts that the cache will hold. If not specified defaults to 1024.

 .. note:

   The implementation is approximate and enforced independently on each worker thread, thus
   it is possible for the maximum hosts in the cache to go slightly above the configured
   value depending on timing. This is similar to how other circuit breakers work.
      .google.protobuf.UInt32Value max_hosts = 5 [(.validate.rules) = { ... }
      Specified by:
      getMaxHostsOrBuilder in interface DnsCacheConfigOrBuilder

    • getDisableDnsRefreshOnFailure

      public boolean getDisableDnsRefreshOnFailure()
       Disable the DNS refresh on failure. If this field is set to true, it will ignore the
 :ref:`typed_dns_resolver_config <envoy_v3_api_field_extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig.dns_failure_refresh_rate>`.
 If not specified, it defaults to false. By enabling this feature, the failed hosts will now be treated as a cache miss,
 allowing the failed hosts to be resolved on demand.
      bool disable_dns_refresh_on_failure = 15;
      Specified by:
      getDisableDnsRefreshOnFailure in interface DnsCacheConfigOrBuilder
      Returns:
      The disableDnsRefreshOnFailure.

    • hasDnsFailureRefreshRate

      public boolean hasDnsFailureRefreshRate()
       If the DNS failure refresh rate is specified,
 this is used as the cache's DNS refresh rate when DNS requests are failing. If this setting is
 not specified, the failure refresh rate defaults to the dns_refresh_rate.
      .envoy.config.cluster.v3.Cluster.RefreshRate dns_failure_refresh_rate = 6;
      Specified by:
      hasDnsFailureRefreshRate in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the dnsFailureRefreshRate field is set.

    • getDnsFailureRefreshRate

      public Cluster.RefreshRate getDnsFailureRefreshRate()
       If the DNS failure refresh rate is specified,
 this is used as the cache's DNS refresh rate when DNS requests are failing. If this setting is
 not specified, the failure refresh rate defaults to the dns_refresh_rate.
      .envoy.config.cluster.v3.Cluster.RefreshRate dns_failure_refresh_rate = 6;
      Specified by:
      getDnsFailureRefreshRate in interface DnsCacheConfigOrBuilder
      Returns:
      The dnsFailureRefreshRate.

    • getDnsFailureRefreshRateOrBuilder

      public Cluster.RefreshRateOrBuilder getDnsFailureRefreshRateOrBuilder()
       If the DNS failure refresh rate is specified,
 this is used as the cache's DNS refresh rate when DNS requests are failing. If this setting is
 not specified, the failure refresh rate defaults to the dns_refresh_rate.
      .envoy.config.cluster.v3.Cluster.RefreshRate dns_failure_refresh_rate = 6;
      Specified by:
      getDnsFailureRefreshRateOrBuilder in interface DnsCacheConfigOrBuilder

    • hasDnsCacheCircuitBreaker

      public boolean hasDnsCacheCircuitBreaker()
       The config of circuit breakers for resolver. It provides a configurable threshold.
 Envoy will use dns cache circuit breakers with default settings even if this value is not set.
      .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheCircuitBreakers dns_cache_circuit_breaker = 7;
      Specified by:
      hasDnsCacheCircuitBreaker in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the dnsCacheCircuitBreaker field is set.

    • getDnsCacheCircuitBreaker

      public DnsCacheCircuitBreakers getDnsCacheCircuitBreaker()
       The config of circuit breakers for resolver. It provides a configurable threshold.
 Envoy will use dns cache circuit breakers with default settings even if this value is not set.
      .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheCircuitBreakers dns_cache_circuit_breaker = 7;
      Specified by:
      getDnsCacheCircuitBreaker in interface DnsCacheConfigOrBuilder
      Returns:
      The dnsCacheCircuitBreaker.

    • getDnsCacheCircuitBreakerOrBuilder

      public DnsCacheCircuitBreakersOrBuilder getDnsCacheCircuitBreakerOrBuilder()
       The config of circuit breakers for resolver. It provides a configurable threshold.
 Envoy will use dns cache circuit breakers with default settings even if this value is not set.
      .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheCircuitBreakers dns_cache_circuit_breaker = 7;
      Specified by:
      getDnsCacheCircuitBreakerOrBuilder in interface DnsCacheConfigOrBuilder

    • getUseTcpForDnsLookups

      @Deprecated public boolean getUseTcpForDnsLookups()
      Deprecated.
      envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig.use_tcp_for_dns_lookups is deprecated. See envoy/extensions/common/dynamic_forward_proxy/v3/dns_cache.proto;l=114
       Always use TCP queries instead of UDP queries for DNS lookups.
 This field is deprecated in favor of ``dns_resolution_config``
 which aggregates all of the DNS resolver configuration in a single message.
      bool use_tcp_for_dns_lookups = 8 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getUseTcpForDnsLookups in interface DnsCacheConfigOrBuilder
      Returns:
      The useTcpForDnsLookups.

    • hasDnsResolutionConfig

      @Deprecated public boolean hasDnsResolutionConfig()
      Deprecated.
      envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig.dns_resolution_config is deprecated. See envoy/extensions/common/dynamic_forward_proxy/v3/dns_cache.proto;l=120
       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.common.dynamic_forward_proxy.v3.DnsCacheConfig.typed_dns_resolver_config>`.
      .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasDnsResolutionConfig in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the dnsResolutionConfig field is set.

    • getDnsResolutionConfig

      @Deprecated public DnsResolutionConfig getDnsResolutionConfig()
      Deprecated.
      envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig.dns_resolution_config is deprecated. See envoy/extensions/common/dynamic_forward_proxy/v3/dns_cache.proto;l=120
       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.common.dynamic_forward_proxy.v3.DnsCacheConfig.typed_dns_resolver_config>`.
      .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getDnsResolutionConfig in interface DnsCacheConfigOrBuilder
      Returns:
      The dnsResolutionConfig.

    • getDnsResolutionConfigOrBuilder

      @Deprecated public 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.common.dynamic_forward_proxy.v3.DnsCacheConfig.typed_dns_resolver_config>`.
      .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getDnsResolutionConfigOrBuilder in interface DnsCacheConfigOrBuilder

    • hasTypedDnsResolverConfig

      public 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.common.dynamic_forward_proxy.v3.DnsCacheConfig.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 = 12;
      Specified by:
      hasTypedDnsResolverConfig in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the typedDnsResolverConfig field is set.

    • getTypedDnsResolverConfig

      public 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.common.dynamic_forward_proxy.v3.DnsCacheConfig.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 = 12;
      Specified by:
      getTypedDnsResolverConfig in interface DnsCacheConfigOrBuilder
      Returns:
      The typedDnsResolverConfig.

    • getTypedDnsResolverConfigOrBuilder

      public 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.common.dynamic_forward_proxy.v3.DnsCacheConfig.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 = 12;
      Specified by:
      getTypedDnsResolverConfigOrBuilder in interface DnsCacheConfigOrBuilder

    • getPreresolveHostnamesList

      public List<SocketAddress> getPreresolveHostnamesList()
       Hostnames that should be preresolved into the cache upon creation. This might provide a
 performance improvement, in the form of cache hits, for hostnames that are going to be
 resolved during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_hostnames = 10;
      Specified by:
      getPreresolveHostnamesList in interface DnsCacheConfigOrBuilder

    • getPreresolveHostnamesOrBuilderList

      public List<? extends SocketAddressOrBuilder> getPreresolveHostnamesOrBuilderList()
       Hostnames that should be preresolved into the cache upon creation. This might provide a
 performance improvement, in the form of cache hits, for hostnames that are going to be
 resolved during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_hostnames = 10;
      Specified by:
      getPreresolveHostnamesOrBuilderList in interface DnsCacheConfigOrBuilder

    • getPreresolveHostnamesCount

      public int getPreresolveHostnamesCount()
       Hostnames that should be preresolved into the cache upon creation. This might provide a
 performance improvement, in the form of cache hits, for hostnames that are going to be
 resolved during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_hostnames = 10;
      Specified by:
      getPreresolveHostnamesCount in interface DnsCacheConfigOrBuilder

    • getPreresolveHostnames

      public SocketAddress getPreresolveHostnames(int index)
       Hostnames that should be preresolved into the cache upon creation. This might provide a
 performance improvement, in the form of cache hits, for hostnames that are going to be
 resolved during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_hostnames = 10;
      Specified by:
      getPreresolveHostnames in interface DnsCacheConfigOrBuilder

    • getPreresolveHostnamesOrBuilder

      public SocketAddressOrBuilder getPreresolveHostnamesOrBuilder(int index)
       Hostnames that should be preresolved into the cache upon creation. This might provide a
 performance improvement, in the form of cache hits, for hostnames that are going to be
 resolved during steady state and are known at config load time.
      repeated .envoy.config.core.v3.SocketAddress preresolve_hostnames = 10;
      Specified by:
      getPreresolveHostnamesOrBuilder in interface DnsCacheConfigOrBuilder

    • hasDnsQueryTimeout

      public boolean hasDnsQueryTimeout()
       The timeout used for DNS queries. This timeout is independent of any timeout and retry policy
 used by the underlying DNS implementation (e.g., c-areas and Apple DNS) which are opaque.
 Setting this timeout will ensure that queries succeed or fail within the specified time frame
 and are then retried using the standard refresh rates. Setting it to 0 will disable the Envoy DNS
 query timeout and use the underlying DNS implementation timeout. Defaults to 5s if not set.
      .google.protobuf.Duration dns_query_timeout = 11 [(.validate.rules) = { ... }
      Specified by:
      hasDnsQueryTimeout in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the dnsQueryTimeout field is set.

    • getDnsQueryTimeout

      public com.google.protobuf.Duration getDnsQueryTimeout()
       The timeout used for DNS queries. This timeout is independent of any timeout and retry policy
 used by the underlying DNS implementation (e.g., c-areas and Apple DNS) which are opaque.
 Setting this timeout will ensure that queries succeed or fail within the specified time frame
 and are then retried using the standard refresh rates. Setting it to 0 will disable the Envoy DNS
 query timeout and use the underlying DNS implementation timeout. Defaults to 5s if not set.
      .google.protobuf.Duration dns_query_timeout = 11 [(.validate.rules) = { ... }
      Specified by:
      getDnsQueryTimeout in interface DnsCacheConfigOrBuilder
      Returns:
      The dnsQueryTimeout.

    • getDnsQueryTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getDnsQueryTimeoutOrBuilder()
       The timeout used for DNS queries. This timeout is independent of any timeout and retry policy
 used by the underlying DNS implementation (e.g., c-areas and Apple DNS) which are opaque.
 Setting this timeout will ensure that queries succeed or fail within the specified time frame
 and are then retried using the standard refresh rates. Setting it to 0 will disable the Envoy DNS
 query timeout and use the underlying DNS implementation timeout. Defaults to 5s if not set.
      .google.protobuf.Duration dns_query_timeout = 11 [(.validate.rules) = { ... }
      Specified by:
      getDnsQueryTimeoutOrBuilder in interface DnsCacheConfigOrBuilder

    • hasKeyValueConfig

      public boolean hasKeyValueConfig()
       Configuration to flush the DNS cache to long term storage.
      .envoy.config.common.key_value.v3.KeyValueStoreConfig key_value_config = 13;
      Specified by:
      hasKeyValueConfig in interface DnsCacheConfigOrBuilder
      Returns:
      Whether the keyValueConfig field is set.

    • getKeyValueConfig

      public KeyValueStoreConfig getKeyValueConfig()
       Configuration to flush the DNS cache to long term storage.
      .envoy.config.common.key_value.v3.KeyValueStoreConfig key_value_config = 13;
      Specified by:
      getKeyValueConfig in interface DnsCacheConfigOrBuilder
      Returns:
      The keyValueConfig.

    • getKeyValueConfigOrBuilder

      public KeyValueStoreConfigOrBuilder getKeyValueConfigOrBuilder()
       Configuration to flush the DNS cache to long term storage.
      .envoy.config.common.key_value.v3.KeyValueStoreConfig key_value_config = 13;
      Specified by:
      getKeyValueConfigOrBuilder in interface DnsCacheConfigOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DnsCacheConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DnsCacheConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DnsCacheConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DnsCacheConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DnsCacheConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DnsCacheConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DnsCacheConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DnsCacheConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DnsCacheConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DnsCacheConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DnsCacheConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DnsCacheConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DnsCacheConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DnsCacheConfig.Builder newBuilder()

    • newBuilder

      public static DnsCacheConfig.Builder newBuilder(DnsCacheConfig prototype)

    • toBuilder

      public DnsCacheConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DnsCacheConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static DnsCacheConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DnsCacheConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<DnsCacheConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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