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

Interface DnsFilterConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DnsFilterConfig, DnsFilterConfig.Builder
public interface DnsFilterConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    AccessLog
    getAccessLog(int index)
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the DNS filter for each DNS query received.
    int
    getAccessLogCount()
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the DNS filter for each DNS query received.
    List<AccessLog>
    getAccessLogList()
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the DNS filter for each DNS query received.
    AccessLogOrBuilder
    getAccessLogOrBuilder(int index)
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the DNS filter for each DNS query received.
    List<? extends AccessLogOrBuilder>
    getAccessLogOrBuilderList()
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the DNS filter for each DNS query received.
    DnsFilterConfig.ClientContextConfig
    getClientConfig()
    Client context configuration controls Envoy's behavior when it must use external resolvers to answer a query.
    DnsFilterConfig.ClientContextConfigOrBuilder
    getClientConfigOrBuilder()
    Client context configuration controls Envoy's behavior when it must use external resolvers to answer a query.
    DnsFilterConfig.ServerContextConfig
    getServerConfig()
    Server context configuration contains the data that the filter uses to respond to DNS requests.
    DnsFilterConfig.ServerContextConfigOrBuilder
    getServerConfigOrBuilder()
    Server context configuration contains the data that the filter uses to respond to DNS requests.
    String
    getStatPrefix()
    The stat prefix used when emitting DNS filter statistics
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The stat prefix used when emitting DNS filter statistics
    boolean
    hasClientConfig()
    Client context configuration controls Envoy's behavior when it must use external resolvers to answer a query.
    boolean
    hasServerConfig()
    Server context configuration contains the data that the filter uses to respond to DNS requests.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getStatPrefix

      String getStatPrefix()
       The stat prefix used when emitting DNS filter statistics
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      com.google.protobuf.ByteString getStatPrefixBytes()
       The stat prefix used when emitting DNS filter statistics
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for statPrefix.

    • hasServerConfig

      boolean hasServerConfig()
       Server context configuration contains the data that the filter uses to respond
 to DNS requests.
      .envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ServerContextConfig server_config = 2;
      Returns:
      Whether the serverConfig field is set.

    • getServerConfig

      DnsFilterConfig.ServerContextConfig getServerConfig()
       Server context configuration contains the data that the filter uses to respond
 to DNS requests.
      .envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ServerContextConfig server_config = 2;
      Returns:
      The serverConfig.

    • getServerConfigOrBuilder

      DnsFilterConfig.ServerContextConfigOrBuilder getServerConfigOrBuilder()
       Server context configuration contains the data that the filter uses to respond
 to DNS requests.
      .envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ServerContextConfig server_config = 2;

    • hasClientConfig

      boolean hasClientConfig()
       Client context configuration controls Envoy's behavior when it must use external
 resolvers to answer a query. This object is optional and if omitted instructs
 the filter to resolve queries from the data in the server_config.
 Also, if ``client_config`` is omitted, here is the Envoy's behavior to create DNS resolver:

 1. If :ref:`typed_dns_resolver_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.typed_dns_resolver_config>`
 is not empty, uses it.

 2. Otherwise, uses the default c-ares DNS resolver.
      .envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig client_config = 3;
      Returns:
      Whether the clientConfig field is set.

    • getClientConfig

      DnsFilterConfig.ClientContextConfig getClientConfig()
       Client context configuration controls Envoy's behavior when it must use external
 resolvers to answer a query. This object is optional and if omitted instructs
 the filter to resolve queries from the data in the server_config.
 Also, if ``client_config`` is omitted, here is the Envoy's behavior to create DNS resolver:

 1. If :ref:`typed_dns_resolver_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.typed_dns_resolver_config>`
 is not empty, uses it.

 2. Otherwise, uses the default c-ares DNS resolver.
      .envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig client_config = 3;
      Returns:
      The clientConfig.

    • getClientConfigOrBuilder

      DnsFilterConfig.ClientContextConfigOrBuilder getClientConfigOrBuilder()
       Client context configuration controls Envoy's behavior when it must use external
 resolvers to answer a query. This object is optional and if omitted instructs
 the filter to resolve queries from the data in the server_config.
 Also, if ``client_config`` is omitted, here is the Envoy's behavior to create DNS resolver:

 1. If :ref:`typed_dns_resolver_config <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.typed_dns_resolver_config>`
 is not empty, uses it.

 2. Otherwise, uses the default c-ares DNS resolver.
      .envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig.ClientContextConfig client_config = 3;

    • getAccessLogList

      List<AccessLog> getAccessLogList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the DNS filter for each DNS query received.
 Supports custom format commands for DNS-specific attributes:
 - ``QUERY_NAME``: The DNS query name being resolved
 - ``QUERY_TYPE``: The DNS query type (A, AAAA, SRV, etc.)
 - ``QUERY_CLASS``: The DNS query class
 - ``ANSWER_COUNT``: Number of answers in the response
 - ``RESPONSE_CODE``: DNS response code
 - ``PARSE_STATUS``: Whether the query was successfully parsed
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 4;

    • getAccessLog

      AccessLog getAccessLog(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the DNS filter for each DNS query received.
 Supports custom format commands for DNS-specific attributes:
 - ``QUERY_NAME``: The DNS query name being resolved
 - ``QUERY_TYPE``: The DNS query type (A, AAAA, SRV, etc.)
 - ``QUERY_CLASS``: The DNS query class
 - ``ANSWER_COUNT``: Number of answers in the response
 - ``RESPONSE_CODE``: DNS response code
 - ``PARSE_STATUS``: Whether the query was successfully parsed
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 4;

    • getAccessLogCount

      int getAccessLogCount()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the DNS filter for each DNS query received.
 Supports custom format commands for DNS-specific attributes:
 - ``QUERY_NAME``: The DNS query name being resolved
 - ``QUERY_TYPE``: The DNS query type (A, AAAA, SRV, etc.)
 - ``QUERY_CLASS``: The DNS query class
 - ``ANSWER_COUNT``: Number of answers in the response
 - ``RESPONSE_CODE``: DNS response code
 - ``PARSE_STATUS``: Whether the query was successfully parsed
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 4;

    • getAccessLogOrBuilderList

      List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the DNS filter for each DNS query received.
 Supports custom format commands for DNS-specific attributes:
 - ``QUERY_NAME``: The DNS query name being resolved
 - ``QUERY_TYPE``: The DNS query type (A, AAAA, SRV, etc.)
 - ``QUERY_CLASS``: The DNS query class
 - ``ANSWER_COUNT``: Number of answers in the response
 - ``RESPONSE_CODE``: DNS response code
 - ``PARSE_STATUS``: Whether the query was successfully parsed
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 4;

    • getAccessLogOrBuilder

      AccessLogOrBuilder getAccessLogOrBuilder(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the DNS filter for each DNS query received.
 Supports custom format commands for DNS-specific attributes:
 - ``QUERY_NAME``: The DNS query name being resolved
 - ``QUERY_TYPE``: The DNS query type (A, AAAA, SRV, etc.)
 - ``QUERY_CLASS``: The DNS query class
 - ``ANSWER_COUNT``: Number of answers in the response
 - ``RESPONSE_CODE``: DNS response code
 - ``PARSE_STATUS``: Whether the query was successfully parsed
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 4;