Package io.envoyproxy.envoy.extensions.network.dns_resolver.cares.v3

Class CaresDnsResolverConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CaresDnsResolverConfigOrBuilder, Serializable
    public final class CaresDnsResolverConfig
extends com.google.protobuf.GeneratedMessageV3
implements CaresDnsResolverConfigOrBuilder
     Configuration for c-ares DNS resolver.
    Protobuf type envoy.extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig
    See Also:
    Serialized Form

    • Field Detail

      • USE_RESOLVERS_AS_FALLBACK_FIELD_NUMBER

        public static final int USE_RESOLVERS_AS_FALLBACK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FILTER_UNROUTABLE_FAMILIES_FIELD_NUMBER

        public static final int FILTER_UNROUTABLE_FAMILIES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DNS_RESOLVER_OPTIONS_FIELD_NUMBER

        public static final int DNS_RESOLVER_OPTIONS_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

      • getResolversList

        public List<Address> getResolversList()
         A list of dns resolver addresses.
 :ref:`use_resolvers_as_fallback<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.use_resolvers_as_fallback>`
 below dictates if the DNS client should override system defaults or only use the provided
 resolvers if the system defaults are not available, i.e., as a fallback.
        repeated .envoy.config.core.v3.Address resolvers = 1 [(.validate.rules) = { ... }
        Specified by:
        getResolversList in interface CaresDnsResolverConfigOrBuilder

      • getResolversOrBuilderList

        public List<? extends AddressOrBuilder> getResolversOrBuilderList()
         A list of dns resolver addresses.
 :ref:`use_resolvers_as_fallback<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.use_resolvers_as_fallback>`
 below dictates if the DNS client should override system defaults or only use the provided
 resolvers if the system defaults are not available, i.e., as a fallback.
        repeated .envoy.config.core.v3.Address resolvers = 1 [(.validate.rules) = { ... }
        Specified by:
        getResolversOrBuilderList in interface CaresDnsResolverConfigOrBuilder

      • getResolversCount

        public int getResolversCount()
         A list of dns resolver addresses.
 :ref:`use_resolvers_as_fallback<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.use_resolvers_as_fallback>`
 below dictates if the DNS client should override system defaults or only use the provided
 resolvers if the system defaults are not available, i.e., as a fallback.
        repeated .envoy.config.core.v3.Address resolvers = 1 [(.validate.rules) = { ... }
        Specified by:
        getResolversCount in interface CaresDnsResolverConfigOrBuilder

      • getResolvers

        public Address getResolvers​(int index)
         A list of dns resolver addresses.
 :ref:`use_resolvers_as_fallback<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.use_resolvers_as_fallback>`
 below dictates if the DNS client should override system defaults or only use the provided
 resolvers if the system defaults are not available, i.e., as a fallback.
        repeated .envoy.config.core.v3.Address resolvers = 1 [(.validate.rules) = { ... }
        Specified by:
        getResolvers in interface CaresDnsResolverConfigOrBuilder

      • getResolversOrBuilder

        public AddressOrBuilder getResolversOrBuilder​(int index)
         A list of dns resolver addresses.
 :ref:`use_resolvers_as_fallback<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.use_resolvers_as_fallback>`
 below dictates if the DNS client should override system defaults or only use the provided
 resolvers if the system defaults are not available, i.e., as a fallback.
        repeated .envoy.config.core.v3.Address resolvers = 1 [(.validate.rules) = { ... }
        Specified by:
        getResolversOrBuilder in interface CaresDnsResolverConfigOrBuilder

      • getUseResolversAsFallback

        public boolean getUseResolversAsFallback()
         If true use the resolvers listed in the
 :ref:`resolvers<envoy_v3_api_field_extensions.network.dns_resolver.cares.v3.CaresDnsResolverConfig.resolvers>`
 field only if c-ares is unable to obtain a
 nameserver from the system (e.g., /etc/resolv.conf).
 Otherwise, the resolvers listed in the resolvers list will override the default system
 resolvers. Defaults to false.
        bool use_resolvers_as_fallback = 3;
        Specified by:
        getUseResolversAsFallback in interface CaresDnsResolverConfigOrBuilder
        Returns:
        The useResolversAsFallback.

      • getFilterUnroutableFamilies

        public boolean getFilterUnroutableFamilies()
         The resolver will query available network interfaces and determine if there are no available
 interfaces for a given IP family. It will then filter these addresses from the results it
 presents. e.g., if there are no available IPv4 network interfaces, the resolver will not
 provide IPv4 addresses.
        bool filter_unroutable_families = 4;
        Specified by:
        getFilterUnroutableFamilies in interface CaresDnsResolverConfigOrBuilder
        Returns:
        The filterUnroutableFamilies.

      • hasDnsResolverOptions

        public boolean hasDnsResolverOptions()
         Configuration of DNS resolver option flags which control the behavior of the DNS resolver.
        .envoy.config.core.v3.DnsResolverOptions dns_resolver_options = 2;
        Specified by:
        hasDnsResolverOptions in interface CaresDnsResolverConfigOrBuilder
        Returns:
        Whether the dnsResolverOptions field is set.

      • 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 CaresDnsResolverConfig parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<CaresDnsResolverConfig> 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 CaresDnsResolverConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder