Package io.envoyproxy.envoy.config.common.dynamic_forward_proxy.v2alpha

Class 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: 7]
    Protobuf type envoy.config.common.dynamic_forward_proxy.v2alpha.DnsCacheConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DnsCacheConfig.Builder
      Configuration for the dynamic forward proxy DNS cache.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • DNS_LOOKUP_FAMILY_FIELD_NUMBER

        public static final int DNS_LOOKUP_FAMILY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DNS_REFRESH_RATE_FIELD_NUMBER

        public static final int DNS_REFRESH_RATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER

        public static final int DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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.api.v2.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.api.v2.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 currently cached DNS hosts. If not specified defaults to 60s.
 .. note:
  The returned DNS TTL is not currently used to alter the refresh rate. This feature will be
  added in a future change.
 .. note:
 The refresh rate is rounded to the closest millisecond, and must be at least 1ms.
        .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 currently cached DNS hosts. If not specified defaults to 60s.
 .. note:
  The returned DNS TTL is not currently used to alter the refresh rate. This feature will be
  added in a future change.
 .. note:
 The refresh rate is rounded to the closest millisecond, and must be at least 1ms.
        .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 currently cached DNS hosts. If not specified defaults to 60s.
 .. note:
  The returned DNS TTL is not currently used to alter the refresh rate. This feature will be
  added in a future change.
 .. note:
 The refresh rate is rounded to the closest millisecond, and must be at least 1ms.
        .google.protobuf.Duration dns_refresh_rate = 3 [(.validate.rules) = { ... }
        Specified by:
        getDnsRefreshRateOrBuilder 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

      • 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.api.v2.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.api.v2.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.api.v2.Cluster.RefreshRate dns_failure_refresh_rate = 6;
        Specified by:
        getDnsFailureRefreshRateOrBuilder 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​(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

      • 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