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

Class FilterConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterConfigOrBuilder, Cloneable
    Enclosing class:
    FilterConfig
    public static final class FilterConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>
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

    • Method Detail

      • 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.Builder<FilterConfig.Builder>

      • clear

        public FilterConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • getDefaultInstanceForType

        public FilterConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public FilterConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • setField

        public FilterConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • clearField

        public FilterConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • clearOneof

        public FilterConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • setRepeatedField

        public FilterConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • addRepeatedField

        public FilterConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • mergeFrom

        public FilterConfig.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FilterConfig.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • mergeFrom

        public FilterConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FilterConfig.Builder>
        Throws:
        IOException

      • 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.

      • setStatPrefix

        public FilterConfig.Builder setStatPrefix​(String value)
         The prefix to use when emitting :ref:`statistics <config_udp_session_filters_dynamic_forward_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The statPrefix to set.
        Returns:
        This builder for chaining.

      • clearStatPrefix

        public FilterConfig.Builder clearStatPrefix()
         The prefix to use when emitting :ref:`statistics <config_udp_session_filters_dynamic_forward_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setStatPrefixBytes

        public FilterConfig.Builder setStatPrefixBytes​(com.google.protobuf.ByteString value)
         The prefix to use when emitting :ref:`statistics <config_udp_session_filters_dynamic_forward_proxy_stats>`.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for statPrefix to set.
        Returns:
        This builder for chaining.

      • 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.

      • setDnsCacheConfig

        public FilterConfig.Builder setDnsCacheConfig​(DnsCacheConfig value)
         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) = { ... }

      • setDnsCacheConfig

        public FilterConfig.Builder setDnsCacheConfig​(DnsCacheConfig.Builder builderForValue)
         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) = { ... }

      • mergeDnsCacheConfig

        public FilterConfig.Builder mergeDnsCacheConfig​(DnsCacheConfig value)
         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) = { ... }

      • clearDnsCacheConfig

        public FilterConfig.Builder clearDnsCacheConfig()
         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) = { ... }

      • getDnsCacheConfigBuilder

        public DnsCacheConfig.Builder getDnsCacheConfigBuilder()
         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) = { ... }

      • 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.

      • setBufferOptions

        public FilterConfig.Builder setBufferOptions​(FilterConfig.BufferOptions value)
         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;

      • setBufferOptions

        public FilterConfig.Builder setBufferOptions​(FilterConfig.BufferOptions.Builder builderForValue)
         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;

      • mergeBufferOptions

        public FilterConfig.Builder mergeBufferOptions​(FilterConfig.BufferOptions value)
         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;

      • clearBufferOptions

        public FilterConfig.Builder clearBufferOptions()
         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;

      • getBufferOptionsBuilder

        public FilterConfig.BufferOptions.Builder getBufferOptionsBuilder()
         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;

      • 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

      • setUnknownFields

        public final FilterConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>

      • mergeUnknownFields

        public final FilterConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>