Package io.envoyproxy.envoy.extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3

Class FilterConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterConfigOrBuilder, Serializable
    public final class FilterConfig
extends com.google.protobuf.GeneratedMessageV3
implements FilterConfigOrBuilder
     Configuration for the filter state based dynamic forward proxy filter. See the
 :ref:`architecture overview <arch_overview_http_dynamic_forward_proxy>` for
 more information. Note this filter must be used in conjunction to another filter that
 sets the 'envoy.upstream.dynamic_host' and the 'envoy.upstream.dynamic_port' filter
 state keys for the required upstream UDP session.
 [#extension: envoy.filters.udp.session.dynamic_forward_proxy]
    Protobuf type envoy.extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig
    See Also:
    Serialized Form

    • Field Detail

      • STAT_PREFIX_FIELD_NUMBER

        public static final int STAT_PREFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DNS_CACHE_CONFIG_FIELD_NUMBER

        public static final int DNS_CACHE_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BUFFER_OPTIONS_FIELD_NUMBER

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

      • getStatPrefix

        public String getStatPrefix()
         The prefix to use when emitting :ref:`statistics <config_udp_session_filters_dynamic_forward_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefix in interface FilterConfigOrBuilder
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        public com.google.protobuf.ByteString getStatPrefixBytes()
         The prefix to use when emitting :ref:`statistics <config_udp_session_filters_dynamic_forward_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Specified by:
        getStatPrefixBytes in interface FilterConfigOrBuilder
        Returns:
        The bytes for statPrefix.

      • hasDnsCacheConfig

        public boolean hasDnsCacheConfig()
         The DNS cache configuration that the filter will attach to. Note this
 configuration must match that of associated :ref:`dynamic forward proxy cluster configuration
 <envoy_v3_api_field_extensions.clusters.dynamic_forward_proxy.v3.ClusterConfig.dns_cache_config>`.
        .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig dns_cache_config = 2 [(.validate.rules) = { ... }
        Specified by:
        hasDnsCacheConfig in interface FilterConfigOrBuilder
        Returns:
        Whether the dnsCacheConfig field is set.

      • getDnsCacheConfig

        public DnsCacheConfig getDnsCacheConfig()
         The DNS cache configuration that the filter will attach to. Note this
 configuration must match that of associated :ref:`dynamic forward proxy cluster configuration
 <envoy_v3_api_field_extensions.clusters.dynamic_forward_proxy.v3.ClusterConfig.dns_cache_config>`.
        .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig dns_cache_config = 2 [(.validate.rules) = { ... }
        Specified by:
        getDnsCacheConfig in interface FilterConfigOrBuilder
        Returns:
        The dnsCacheConfig.

      • getDnsCacheConfigOrBuilder

        public DnsCacheConfigOrBuilder getDnsCacheConfigOrBuilder()
         The DNS cache configuration that the filter will attach to. Note this
 configuration must match that of associated :ref:`dynamic forward proxy cluster configuration
 <envoy_v3_api_field_extensions.clusters.dynamic_forward_proxy.v3.ClusterConfig.dns_cache_config>`.
        .envoy.extensions.common.dynamic_forward_proxy.v3.DnsCacheConfig dns_cache_config = 2 [(.validate.rules) = { ... }
        Specified by:
        getDnsCacheConfigOrBuilder in interface FilterConfigOrBuilder

      • hasBufferOptions

        public boolean hasBufferOptions()
         If configured, the filter will buffer datagrams in case that it is waiting for a DNS response.
 If this field is not configured, there will be no buffering and downstream datagrams that arrive
 while the DNS resolution is in progress will be dropped. In case this field is set but the options
 are not configured, the default values will be applied as described in the ``BufferOptions``.
        .envoy.extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig.BufferOptions buffer_options = 3;
        Specified by:
        hasBufferOptions in interface FilterConfigOrBuilder
        Returns:
        Whether the bufferOptions field is set.

      • getBufferOptions

        public FilterConfig.BufferOptions getBufferOptions()
         If configured, the filter will buffer datagrams in case that it is waiting for a DNS response.
 If this field is not configured, there will be no buffering and downstream datagrams that arrive
 while the DNS resolution is in progress will be dropped. In case this field is set but the options
 are not configured, the default values will be applied as described in the ``BufferOptions``.
        .envoy.extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig.BufferOptions buffer_options = 3;
        Specified by:
        getBufferOptions in interface FilterConfigOrBuilder
        Returns:
        The bufferOptions.

      • getBufferOptionsOrBuilder

        public FilterConfig.BufferOptionsOrBuilder getBufferOptionsOrBuilder()
         If configured, the filter will buffer datagrams in case that it is waiting for a DNS response.
 If this field is not configured, there will be no buffering and downstream datagrams that arrive
 while the DNS resolution is in progress will be dropped. In case this field is set but the options
 are not configured, the default values will be applied as described in the ``BufferOptions``.
        .envoy.extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig.BufferOptions buffer_options = 3;
        Specified by:
        getBufferOptionsOrBuilder in interface FilterConfigOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static FilterConfig getDefaultInstance()

      • parser

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

      • getParserForType

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