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: 9]Protobuf type
envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig| Modifier and Type | Class and Description |
|---|---|
static class |
DnsCacheConfig.Builder
Configuration for the dynamic forward proxy DNS cache.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
DNS_CACHE_CIRCUIT_BREAKER_FIELD_NUMBER |
static int |
DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER |
static int |
DNS_LOOKUP_FAMILY_FIELD_NUMBER |
static int |
DNS_REFRESH_RATE_FIELD_NUMBER |
static int |
HOST_TTL_FIELD_NUMBER |
static int |
MAX_HOSTS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
USE_TCP_FOR_DNS_LOOKUPS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static DnsCacheConfig |
getDefaultInstance() |
DnsCacheConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
DnsCacheCircuitBreakers |
getDnsCacheCircuitBreaker()
The config of circuit breakers for resolver.
|
DnsCacheCircuitBreakersOrBuilder |
getDnsCacheCircuitBreakerOrBuilder()
The config of circuit breakers for resolver.
|
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.
|
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.
|
Cluster.DnsLookupFamily |
getDnsLookupFamily()
The DNS lookup family to use during resolution.
|
int |
getDnsLookupFamilyValue()
The DNS lookup family to use during resolution.
|
com.google.protobuf.Duration |
getDnsRefreshRate()
The DNS refresh rate for currently cached DNS hosts.
|
com.google.protobuf.DurationOrBuilder |
getDnsRefreshRateOrBuilder()
The DNS refresh rate for currently cached DNS hosts.
|
com.google.protobuf.Duration |
getHostTtl()
The TTL for hosts that are unused.
|
com.google.protobuf.DurationOrBuilder |
getHostTtlOrBuilder()
The TTL for hosts that are unused.
|
com.google.protobuf.UInt32Value |
getMaxHosts()
The maximum number of hosts that the cache will hold.
|
com.google.protobuf.UInt32ValueOrBuilder |
getMaxHostsOrBuilder()
The maximum number of hosts that the cache will hold.
|
String |
getName()
The name of the cache.
|
com.google.protobuf.ByteString |
getNameBytes()
The name of the cache.
|
com.google.protobuf.Parser<DnsCacheConfig> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
getUseTcpForDnsLookups()
[#next-major-version: Reconcile DNS options in a single message.]
|
boolean |
hasDnsCacheCircuitBreaker()
The config of circuit breakers for resolver.
|
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.
|
boolean |
hasDnsRefreshRate()
The DNS refresh rate for currently cached DNS hosts.
|
int |
hashCode() |
boolean |
hasHostTtl()
The TTL for hosts that are unused.
|
boolean |
hasMaxHosts()
The maximum number of hosts that the cache will hold.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DnsCacheConfig.Builder |
newBuilder() |
static DnsCacheConfig.Builder |
newBuilder(DnsCacheConfig prototype) |
DnsCacheConfig.Builder |
newBuilderForType() |
protected DnsCacheConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static DnsCacheConfig |
parseDelimitedFrom(InputStream input) |
static DnsCacheConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DnsCacheConfig |
parseFrom(byte[] data) |
static DnsCacheConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DnsCacheConfig |
parseFrom(ByteBuffer data) |
static DnsCacheConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DnsCacheConfig |
parseFrom(com.google.protobuf.ByteString data) |
static DnsCacheConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DnsCacheConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static DnsCacheConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DnsCacheConfig |
parseFrom(InputStream input) |
static DnsCacheConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<DnsCacheConfig> |
parser() |
DnsCacheConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DNS_LOOKUP_FAMILY_FIELD_NUMBER
public static final int DNS_REFRESH_RATE_FIELD_NUMBER
public static final int HOST_TTL_FIELD_NUMBER
public static final int MAX_HOSTS_FIELD_NUMBER
public static final int DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER
public static final int DNS_CACHE_CIRCUIT_BREAKER_FIELD_NUMBER
public static final int USE_TCP_FOR_DNS_LOOKUPS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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) = { ... }getName in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getNameBytes in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getDnsLookupFamilyValue in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getDnsLookupFamily in interface DnsCacheConfigOrBuilderpublic 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) = { ... }hasDnsRefreshRate in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getDnsRefreshRate in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getDnsRefreshRateOrBuilder in interface DnsCacheConfigOrBuilderpublic 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) = { ... }hasHostTtl in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getHostTtl in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getHostTtlOrBuilder in interface DnsCacheConfigOrBuilderpublic 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) = { ... }hasMaxHosts in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getMaxHosts in interface DnsCacheConfigOrBuilderpublic 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) = { ... }getMaxHostsOrBuilder in interface DnsCacheConfigOrBuilderpublic 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;hasDnsFailureRefreshRate in interface DnsCacheConfigOrBuilderpublic 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;getDnsFailureRefreshRate in interface DnsCacheConfigOrBuilderpublic 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;getDnsFailureRefreshRateOrBuilder in interface DnsCacheConfigOrBuilderpublic boolean hasDnsCacheCircuitBreaker()
The config of circuit breakers for resolver. It provides a configurable threshold. If `envoy.reloadable_features.enable_dns_cache_circuit_breakers` is enabled, 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;hasDnsCacheCircuitBreaker in interface DnsCacheConfigOrBuilderpublic DnsCacheCircuitBreakers getDnsCacheCircuitBreaker()
The config of circuit breakers for resolver. It provides a configurable threshold. If `envoy.reloadable_features.enable_dns_cache_circuit_breakers` is enabled, 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;getDnsCacheCircuitBreaker in interface DnsCacheConfigOrBuilderpublic DnsCacheCircuitBreakersOrBuilder getDnsCacheCircuitBreakerOrBuilder()
The config of circuit breakers for resolver. It provides a configurable threshold. If `envoy.reloadable_features.enable_dns_cache_circuit_breakers` is enabled, 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;getDnsCacheCircuitBreakerOrBuilder in interface DnsCacheConfigOrBuilderpublic boolean getUseTcpForDnsLookups()
[#next-major-version: Reconcile DNS options in a single message.] Always use TCP queries instead of UDP queries for DNS lookups. Setting this value causes failure if the ``envoy.restart_features.use_apple_api_for_dns_lookups`` runtime value is true during server startup. Apple' API only uses UDP for DNS resolution.
bool use_tcp_for_dns_lookups = 8;getUseTcpForDnsLookups in interface DnsCacheConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static DnsCacheConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DnsCacheConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DnsCacheConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DnsCacheConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DnsCacheConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DnsCacheConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static DnsCacheConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static DnsCacheConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DnsCacheConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static DnsCacheConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static DnsCacheConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static DnsCacheConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic DnsCacheConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static DnsCacheConfig.Builder newBuilder()
public static DnsCacheConfig.Builder newBuilder(DnsCacheConfig prototype)
public DnsCacheConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected DnsCacheConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static DnsCacheConfig getDefaultInstance()
public static com.google.protobuf.Parser<DnsCacheConfig> parser()
public com.google.protobuf.Parser<DnsCacheConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public DnsCacheConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018–2021 The Envoy Project. All rights reserved.