Class DnsCacheConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.common.dynamic_forward_proxy.v2alpha.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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classConfiguration 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic DnsCacheConfigstatic final com.google.protobuf.Descriptors.DescriptorIf the DNS failure refresh rate is specified, this is used as the cache's DNS refresh rate when DNS requests are failing.If the DNS failure refresh rate is specified, this is used as the cache's DNS refresh rate when DNS requests are failing.The DNS lookup family to use during resolution.intThe DNS lookup family to use during resolution.com.google.protobuf.DurationThe DNS refresh rate for currently cached DNS hosts.com.google.protobuf.DurationOrBuilderThe DNS refresh rate for currently cached DNS hosts.com.google.protobuf.DurationThe TTL for hosts that are unused.com.google.protobuf.DurationOrBuilderThe TTL for hosts that are unused.com.google.protobuf.UInt32ValueThe maximum number of hosts that the cache will hold.com.google.protobuf.UInt32ValueOrBuilderThe maximum number of hosts that the cache will hold.getName()The name of the cache.com.google.protobuf.ByteStringThe name of the cache.com.google.protobuf.Parser<DnsCacheConfig>intbooleanIf the DNS failure refresh rate is specified, this is used as the cache's DNS refresh rate when DNS requests are failing.booleanThe DNS refresh rate for currently cached DNS hosts.inthashCode()booleanThe TTL for hosts that are unused.booleanThe maximum number of hosts that the cache will hold.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic DnsCacheConfig.Builderstatic DnsCacheConfig.BuildernewBuilder(DnsCacheConfig prototype) protected DnsCacheConfig.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static DnsCacheConfigparseDelimitedFrom(InputStream input) static DnsCacheConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DnsCacheConfigparseFrom(byte[] data) static DnsCacheConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DnsCacheConfigparseFrom(com.google.protobuf.ByteString data) static DnsCacheConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DnsCacheConfigparseFrom(com.google.protobuf.CodedInputStream input) static DnsCacheConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DnsCacheConfigparseFrom(InputStream input) static DnsCacheConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DnsCacheConfigparseFrom(ByteBuffer data) static DnsCacheConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<DnsCacheConfig>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
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:
-
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:
-
DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER
public static final int DNS_FAILURE_REFRESH_RATE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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:
getNamein interfaceDnsCacheConfigOrBuilder- 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:
getNameBytesin interfaceDnsCacheConfigOrBuilder- 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:
getDnsLookupFamilyValuein interfaceDnsCacheConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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:
getDnsLookupFamilyin interfaceDnsCacheConfigOrBuilder- 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:
hasDnsRefreshRatein interfaceDnsCacheConfigOrBuilder- 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:
getDnsRefreshRatein interfaceDnsCacheConfigOrBuilder- 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:
getDnsRefreshRateOrBuilderin interfaceDnsCacheConfigOrBuilder
-
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:
hasHostTtlin interfaceDnsCacheConfigOrBuilder- 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:
getHostTtlin interfaceDnsCacheConfigOrBuilder- 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:
getHostTtlOrBuilderin interfaceDnsCacheConfigOrBuilder
-
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:
hasMaxHostsin interfaceDnsCacheConfigOrBuilder- 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:
getMaxHostsin interfaceDnsCacheConfigOrBuilder- 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:
getMaxHostsOrBuilderin interfaceDnsCacheConfigOrBuilder
-
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:
hasDnsFailureRefreshRatein interfaceDnsCacheConfigOrBuilder- Returns:
- Whether the dnsFailureRefreshRate field is set.
-
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:
getDnsFailureRefreshRatein interfaceDnsCacheConfigOrBuilder- Returns:
- The dnsFailureRefreshRate.
-
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:
getDnsFailureRefreshRateOrBuilderin interfaceDnsCacheConfigOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static DnsCacheConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected DnsCacheConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-