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

Class DnsFilterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DnsFilterConfigOrBuilder, Serializable
public final class DnsFilterConfig extends com.google.protobuf.GeneratedMessageV3 implements DnsFilterConfigOrBuilder
 Configuration for the DNS filter.
Protobuf type envoy.extensions.filters.udp.dns_filter.v3.DnsFilterConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DnsFilterConfig.Builder
    Configuration for the DNS filter.
    static final class 
    DnsFilterConfig.ClientContextConfig
    This message contains the configuration for the DNS Filter operating in a client context.
    static interface 
    DnsFilterConfig.ClientContextConfigOrBuilder
     
    static final class 
    DnsFilterConfig.ServerContextConfig
    This message contains the configuration for the DNS Filter operating in a server context.
    static interface 
    DnsFilterConfig.ServerContextConfigOrBuilder
     

    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

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACCESS_LOG_FIELD_NUMBER
     
    static final int
    CLIENT_CONFIG_FIELD_NUMBER
     
    static final int
    SERVER_CONFIG_FIELD_NUMBER
     
    static final int
    STAT_PREFIX_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static DnsFilterConfig
    getDefaultInstance()
     
    DnsFilterConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<DnsFilterConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    boolean
    hasServerConfig()
    Server context configuration contains the data that the filter uses to respond to DNS requests.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DnsFilterConfig.Builder
    newBuilder()
     
    static DnsFilterConfig.Builder
    newBuilder(DnsFilterConfig prototype)
     
    DnsFilterConfig.Builder
    newBuilderForType()
     
    protected DnsFilterConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static DnsFilterConfig
    parseDelimitedFrom(InputStream input)
     
    static DnsFilterConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DnsFilterConfig
    parseFrom(byte[] data)
     
    static DnsFilterConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DnsFilterConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static DnsFilterConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DnsFilterConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DnsFilterConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DnsFilterConfig
    parseFrom(InputStream input)
     
    static DnsFilterConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DnsFilterConfig
    parseFrom(ByteBuffer data)
     
    static DnsFilterConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DnsFilterConfig>
    parser()
     
    DnsFilterConfig.Builder
    toBuilder()
     
    void
    writeTo(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, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • STAT_PREFIX_FIELD_NUMBER

      public static final int STAT_PREFIX_FIELD_NUMBER
      See Also:

    • SERVER_CONFIG_FIELD_NUMBER

      public static final int SERVER_CONFIG_FIELD_NUMBER
      See Also:

    • CLIENT_CONFIG_FIELD_NUMBER

      public static final int CLIENT_CONFIG_FIELD_NUMBER
      See Also:

    • ACCESS_LOG_FIELD_NUMBER

      public static final int ACCESS_LOG_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getStatPrefix

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

    • getStatPrefixBytes

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

    • hasServerConfig

      public 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;
      Specified by:
      hasServerConfig in interface DnsFilterConfigOrBuilder
      Returns:
      Whether the serverConfig field is set.

    • getServerConfig

      public 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;
      Specified by:
      getServerConfig in interface DnsFilterConfigOrBuilder
      Returns:
      The serverConfig.

    • getServerConfigOrBuilder

      public 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;
      Specified by:
      getServerConfigOrBuilder in interface DnsFilterConfigOrBuilder

    • hasClientConfig

      public 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;
      Specified by:
      hasClientConfig in interface DnsFilterConfigOrBuilder
      Returns:
      Whether the clientConfig field is set.

    • getClientConfig

      public 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;
      Specified by:
      getClientConfig in interface DnsFilterConfigOrBuilder
      Returns:
      The clientConfig.

    • getClientConfigOrBuilder

      public 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;
      Specified by:
      getClientConfigOrBuilder in interface DnsFilterConfigOrBuilder

    • getAccessLogList

      public 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;
      Specified by:
      getAccessLogList in interface DnsFilterConfigOrBuilder

    • getAccessLogOrBuilderList

      public 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;
      Specified by:
      getAccessLogOrBuilderList in interface DnsFilterConfigOrBuilder

    • getAccessLogCount

      public 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;
      Specified by:
      getAccessLogCount in interface DnsFilterConfigOrBuilder

    • getAccessLog

      public 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;
      Specified by:
      getAccessLog in interface DnsFilterConfigOrBuilder

    • getAccessLogOrBuilder

      public 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;
      Specified by:
      getAccessLogOrBuilder in interface DnsFilterConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DnsFilterConfig 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static DnsFilterConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DnsFilterConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DnsFilterConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DnsFilterConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DnsFilterConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DnsFilterConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static DnsFilterConfig.Builder newBuilder()

    • newBuilder

      public static DnsFilterConfig.Builder newBuilder(DnsFilterConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DnsFilterConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DnsFilterConfig> parser()

    • getParserForType

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