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

Interface DnsCacheConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DnsCacheConfig, DnsCacheConfig.Builder
    public interface DnsCacheConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

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

      • getNameBytes

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

      • getDnsLookupFamilyValue

        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) = { ... }
        Returns:
        The enum numeric value on the wire for dnsLookupFamily.

      • getDnsLookupFamily

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

      • hasDnsRefreshRate

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

      • getDnsRefreshRate

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

      • getDnsRefreshRateOrBuilder

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

      • hasDnsMinRefreshRate

        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 >= 5s.
        .google.protobuf.Duration dns_min_refresh_rate = 14 [(.validate.rules) = { ... }
        Returns:
        Whether the dnsMinRefreshRate field is set.

      • getDnsMinRefreshRate

        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 >= 5s.
        .google.protobuf.Duration dns_min_refresh_rate = 14 [(.validate.rules) = { ... }
        Returns:
        The dnsMinRefreshRate.

      • getDnsMinRefreshRateOrBuilder

        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 >= 5s.
        .google.protobuf.Duration dns_min_refresh_rate = 14 [(.validate.rules) = { ... }

      • hasHostTtl

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

      • getHostTtl

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

      • getHostTtlOrBuilder

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

      • hasMaxHosts

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

      • getMaxHosts

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

      • getMaxHostsOrBuilder

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

      • hasDnsFailureRefreshRate

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

      • getDnsFailureRefreshRate

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

      • getDnsFailureRefreshRateOrBuilder

        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;

      • hasDnsCacheCircuitBreaker

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

      • getDnsCacheCircuitBreaker

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

      • getDnsCacheCircuitBreakerOrBuilder

        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;

      • getUseTcpForDnsLookups

        @Deprecated
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=108
         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"];
        Returns:
        The useTcpForDnsLookups.

      • hasDnsResolutionConfig

        @Deprecated
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=114
         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"];
        Returns:
        Whether the dnsResolutionConfig field is set.

      • getDnsResolutionConfig

        @Deprecated
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=114
         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"];
        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.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"];

      • 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.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;
        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.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;
        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.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;

      • getPreresolveHostnamesList

        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;

      • getPreresolveHostnames

        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;

      • getPreresolveHostnamesCount

        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;

      • getPreresolveHostnamesOrBuilderList

        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;

      • getPreresolveHostnamesOrBuilder

        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;

      • hasDnsQueryTimeout

        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. Defaults to 5s if not set.
        .google.protobuf.Duration dns_query_timeout = 11 [(.validate.rules) = { ... }
        Returns:
        Whether the dnsQueryTimeout field is set.

      • getDnsQueryTimeout

        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. Defaults to 5s if not set.
        .google.protobuf.Duration dns_query_timeout = 11 [(.validate.rules) = { ... }
        Returns:
        The dnsQueryTimeout.

      • getDnsQueryTimeoutOrBuilder

        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. Defaults to 5s if not set.
        .google.protobuf.Duration dns_query_timeout = 11 [(.validate.rules) = { ... }

      • hasKeyValueConfig

        boolean hasKeyValueConfig()
         [#not-implemented-hide:]
 Configuration to flush the DNS cache to long term storage.
        .envoy.config.common.key_value.v3.KeyValueStoreConfig key_value_config = 13;
        Returns:
        Whether the keyValueConfig field is set.

      • getKeyValueConfig

        KeyValueStoreConfig getKeyValueConfig()
         [#not-implemented-hide:]
 Configuration to flush the DNS cache to long term storage.
        .envoy.config.common.key_value.v3.KeyValueStoreConfig key_value_config = 13;
        Returns:
        The keyValueConfig.

      • getKeyValueConfigOrBuilder

        KeyValueStoreConfigOrBuilder getKeyValueConfigOrBuilder()
         [#not-implemented-hide:]
 Configuration to flush the DNS cache to long term storage.
        .envoy.config.common.key_value.v3.KeyValueStoreConfig key_value_config = 13;