Package io.envoyproxy.envoy.extensions.filters.udp.dns_filter.v3

Class DnsFilterConfig.ClientContextConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DnsFilterConfig.ClientContextConfigOrBuilder, Serializable
    Enclosing class:
    DnsFilterConfig
    public static final class DnsFilterConfig.ClientContextConfig
extends com.google.protobuf.GeneratedMessageV3
implements DnsFilterConfig.ClientContextConfigOrBuilder
     This message contains the configuration for the DNS Filter operating
 in a client context. This message will contain the timeouts, retry,
 and forwarding configuration for Envoy to make DNS requests to other
 resolvers
 [#next-free-field: 6]
    Protobuf type envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig
    See Also:
    Serialized Form

    • Field Detail

      • RESOLVER_TIMEOUT_FIELD_NUMBER

        public static final int RESOLVER_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPSTREAM_RESOLVERS_FIELD_NUMBER

        public static final int UPSTREAM_RESOLVERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DNS_RESOLUTION_CONFIG_FIELD_NUMBER

        public static final int DNS_RESOLUTION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TYPED_DNS_RESOLVER_CONFIG_FIELD_NUMBER

        public static final int TYPED_DNS_RESOLVER_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_PENDING_LOOKUPS_FIELD_NUMBER

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

      • hasResolverTimeout

        public boolean hasResolverTimeout()
         Sets the maximum time we will wait for the upstream query to complete
 We allow 5s for the upstream resolution to complete, so the minimum
 value here is 1. Note that the total latency for a failed query is the
 number of retries multiplied by the resolver_timeout.
        .google.protobuf.Duration resolver_timeout = 1 [(.validate.rules) = { ... }
        Specified by:
        hasResolverTimeout in interface DnsFilterConfig.ClientContextConfigOrBuilder
        Returns:
        Whether the resolverTimeout field is set.

      • getResolverTimeout

        public com.google.protobuf.Duration getResolverTimeout()
         Sets the maximum time we will wait for the upstream query to complete
 We allow 5s for the upstream resolution to complete, so the minimum
 value here is 1. Note that the total latency for a failed query is the
 number of retries multiplied by the resolver_timeout.
        .google.protobuf.Duration resolver_timeout = 1 [(.validate.rules) = { ... }
        Specified by:
        getResolverTimeout in interface DnsFilterConfig.ClientContextConfigOrBuilder
        Returns:
        The resolverTimeout.

      • getResolverTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getResolverTimeoutOrBuilder()
         Sets the maximum time we will wait for the upstream query to complete
 We allow 5s for the upstream resolution to complete, so the minimum
 value here is 1. Note that the total latency for a failed query is the
 number of retries multiplied by the resolver_timeout.
        .google.protobuf.Duration resolver_timeout = 1 [(.validate.rules) = { ... }
        Specified by:
        getResolverTimeoutOrBuilder in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • getUpstreamResolversList

        @Deprecated
public List<Address> getUpstreamResolversList()
        Deprecated.
         This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getUpstreamResolversList in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • getUpstreamResolversOrBuilderList

        @Deprecated
public List<? extends AddressOrBuilder> getUpstreamResolversOrBuilderList()
        Deprecated.
         This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getUpstreamResolversOrBuilderList in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • getUpstreamResolversCount

        @Deprecated
public int getUpstreamResolversCount()
        Deprecated.
         This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getUpstreamResolversCount in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • getUpstreamResolvers

        @Deprecated
public Address getUpstreamResolvers​(int index)
        Deprecated.
         This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getUpstreamResolvers in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • getUpstreamResolversOrBuilder

        @Deprecated
public AddressOrBuilder getUpstreamResolversOrBuilder​(int index)
        Deprecated.
         This field was used for `dns_resolution_config` in Envoy 1.19.0 and
 1.19.1.
 Control planes that need to set this field for Envoy 1.19.0 and
 1.19.1 clients should fork the protobufs and change the field type
 to `DnsResolutionConfig`.
 Control planes that need to simultaneously support Envoy 1.18.x and
 Envoy 1.19.x should avoid Envoy 1.19.0 and 1.19.1.
 [#not-implemented-hide:]
        repeated .envoy.config.core.v3.Address upstream_resolvers = 2 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getUpstreamResolversOrBuilder in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • hasDnsResolutionConfig

        @Deprecated
public boolean hasDnsResolutionConfig()
        Deprecated.
        envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.dns_resolution_config is deprecated. See envoy/extensions/filters/udp/dns_filter/v3/dns_filter.proto;l=73
         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.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.typed_dns_resolver_config>`.
        .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        hasDnsResolutionConfig in interface DnsFilterConfig.ClientContextConfigOrBuilder
        Returns:
        Whether the dnsResolutionConfig field is set.

      • getDnsResolutionConfig

        @Deprecated
public DnsResolutionConfig getDnsResolutionConfig()
        Deprecated.
        envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.dns_resolution_config is deprecated. See envoy/extensions/filters/udp/dns_filter/v3/dns_filter.proto;l=73
         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.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.typed_dns_resolver_config>`.
        .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getDnsResolutionConfig in interface DnsFilterConfig.ClientContextConfigOrBuilder
        Returns:
        The dnsResolutionConfig.

      • getDnsResolutionConfigOrBuilder

        @Deprecated
public 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.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.typed_dns_resolver_config>`.
        .envoy.config.core.v3.DnsResolutionConfig dns_resolution_config = 5 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Specified by:
        getDnsResolutionConfigOrBuilder in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • hasTypedDnsResolverConfig

        public 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.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.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 = 4;
        Specified by:
        hasTypedDnsResolverConfig in interface DnsFilterConfig.ClientContextConfigOrBuilder
        Returns:
        Whether the typedDnsResolverConfig field is set.

      • getTypedDnsResolverConfig

        public 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.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.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 = 4;
        Specified by:
        getTypedDnsResolverConfig in interface DnsFilterConfig.ClientContextConfigOrBuilder
        Returns:
        The typedDnsResolverConfig.

      • getTypedDnsResolverConfigOrBuilder

        public 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.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig.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 = 4;
        Specified by:
        getTypedDnsResolverConfigOrBuilder in interface DnsFilterConfig.ClientContextConfigOrBuilder

      • getMaxPendingLookups

        public long getMaxPendingLookups()
         Controls how many outstanding external lookup contexts the filter tracks.
 The context structure allows the filter to respond to every query even if the external
 resolution times out or is otherwise unsuccessful
        uint64 max_pending_lookups = 3 [(.validate.rules) = { ... }
        Specified by:
        getMaxPendingLookups in interface DnsFilterConfig.ClientContextConfigOrBuilder
        Returns:
        The maxPendingLookups.

      • 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 DnsFilterConfig.ClientContextConfig parseFrom​(ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

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