Package io.envoyproxy.envoy.extensions.filters.http.dynamic_forward_proxy.v3

Class FilterConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<FilterConfig.Builder>
io.envoyproxy.envoy.extensions.filters.http.dynamic_forward_proxy.v3.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 dynamic forward proxy HTTP filter. See the :ref:`architecture overview
 <arch_overview_http_dynamic_forward_proxy>` for more information.
 [#extension: envoy.filters.http.dynamic_forward_proxy]
Protobuf type envoy.extensions.filters.http.dynamic_forward_proxy.v3.FilterConfig

  • Method Details

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

    • mergeFrom

      public FilterConfig.Builder mergeFrom(FilterConfig other)

    • 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

    • getImplementationSpecifierCase

      public FilterConfig.ImplementationSpecifierCase getImplementationSpecifierCase()
      Specified by:
      getImplementationSpecifierCase in interface FilterConfigOrBuilder

    • clearImplementationSpecifier

      public FilterConfig.Builder clearImplementationSpecifier()

    • 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 = 1;
      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 = 1;
      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 = 1;

    • 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 = 1;

    • 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 = 1;

    • 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 = 1;

    • 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 = 1;

    • 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 = 1;
      Specified by:
      getDnsCacheConfigOrBuilder in interface FilterConfigOrBuilder

    • hasSubClusterConfig

      public boolean hasSubClusterConfig()
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;
      Specified by:
      hasSubClusterConfig in interface FilterConfigOrBuilder
      Returns:
      Whether the subClusterConfig field is set.

    • getSubClusterConfig

      public SubClusterConfig getSubClusterConfig()
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;
      Specified by:
      getSubClusterConfig in interface FilterConfigOrBuilder
      Returns:
      The subClusterConfig.

    • setSubClusterConfig

      public FilterConfig.Builder setSubClusterConfig(SubClusterConfig value)
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;

    • setSubClusterConfig

      public FilterConfig.Builder setSubClusterConfig(SubClusterConfig.Builder builderForValue)
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;

    • mergeSubClusterConfig

      public FilterConfig.Builder mergeSubClusterConfig(SubClusterConfig value)
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;

    • clearSubClusterConfig

      public FilterConfig.Builder clearSubClusterConfig()
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;

    • getSubClusterConfigBuilder

      public SubClusterConfig.Builder getSubClusterConfigBuilder()
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;

    • getSubClusterConfigOrBuilder

      public SubClusterConfigOrBuilder getSubClusterConfigOrBuilder()
       The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
 sub clusters.
      .envoy.extensions.filters.http.dynamic_forward_proxy.v3.SubClusterConfig sub_cluster_config = 3;
      Specified by:
      getSubClusterConfigOrBuilder in interface FilterConfigOrBuilder

    • getSaveUpstreamAddress

      public boolean getSaveUpstreamAddress()
       When this flag is set, the filter will add the resolved upstream address in the filter
 state. The state should be saved with key
 ``envoy.stream.upstream_address`` (See
 :repo:`upstream_address.h<source/common/stream_info/upstream_address.h>`).
      bool save_upstream_address = 2;
      Specified by:
      getSaveUpstreamAddress in interface FilterConfigOrBuilder
      Returns:
      The saveUpstreamAddress.

    • setSaveUpstreamAddress

      public FilterConfig.Builder setSaveUpstreamAddress(boolean value)
       When this flag is set, the filter will add the resolved upstream address in the filter
 state. The state should be saved with key
 ``envoy.stream.upstream_address`` (See
 :repo:`upstream_address.h<source/common/stream_info/upstream_address.h>`).
      bool save_upstream_address = 2;
      Parameters:
      value - The saveUpstreamAddress to set.
      Returns:
      This builder for chaining.

    • clearSaveUpstreamAddress

      public FilterConfig.Builder clearSaveUpstreamAddress()
       When this flag is set, the filter will add the resolved upstream address in the filter
 state. The state should be saved with key
 ``envoy.stream.upstream_address`` (See
 :repo:`upstream_address.h<source/common/stream_info/upstream_address.h>`).
      bool save_upstream_address = 2;
      Returns:
      This builder for chaining.

    • getAllowDynamicHostFromFilterState

      public boolean getAllowDynamicHostFromFilterState()
       When this flag is set, the filter will check for the ``envoy.upstream.dynamic_host``
 and/or ``envoy.upstream.dynamic_port`` filter state values before using the HTTP
 Host header for DNS resolution. This provides consistency with the
 :ref:`SNI dynamic forward proxy <envoy_v3_api_msg_extensions.filters.network.sni_dynamic_forward_proxy.v3.FilterConfig>` and
 :ref:`UDP dynamic forward proxy <envoy_v3_api_msg_extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig>`
 filters behavior when enabled.

 If the flag is not set (default), the filter will use the HTTP Host header
 for DNS resolution, maintaining backward compatibility.
      bool allow_dynamic_host_from_filter_state = 4;
      Specified by:
      getAllowDynamicHostFromFilterState in interface FilterConfigOrBuilder
      Returns:
      The allowDynamicHostFromFilterState.

    • setAllowDynamicHostFromFilterState

      public FilterConfig.Builder setAllowDynamicHostFromFilterState(boolean value)
       When this flag is set, the filter will check for the ``envoy.upstream.dynamic_host``
 and/or ``envoy.upstream.dynamic_port`` filter state values before using the HTTP
 Host header for DNS resolution. This provides consistency with the
 :ref:`SNI dynamic forward proxy <envoy_v3_api_msg_extensions.filters.network.sni_dynamic_forward_proxy.v3.FilterConfig>` and
 :ref:`UDP dynamic forward proxy <envoy_v3_api_msg_extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig>`
 filters behavior when enabled.

 If the flag is not set (default), the filter will use the HTTP Host header
 for DNS resolution, maintaining backward compatibility.
      bool allow_dynamic_host_from_filter_state = 4;
      Parameters:
      value - The allowDynamicHostFromFilterState to set.
      Returns:
      This builder for chaining.

    • clearAllowDynamicHostFromFilterState

      public FilterConfig.Builder clearAllowDynamicHostFromFilterState()
       When this flag is set, the filter will check for the ``envoy.upstream.dynamic_host``
 and/or ``envoy.upstream.dynamic_port`` filter state values before using the HTTP
 Host header for DNS resolution. This provides consistency with the
 :ref:`SNI dynamic forward proxy <envoy_v3_api_msg_extensions.filters.network.sni_dynamic_forward_proxy.v3.FilterConfig>` and
 :ref:`UDP dynamic forward proxy <envoy_v3_api_msg_extensions.filters.udp.udp_proxy.session.dynamic_forward_proxy.v3.FilterConfig>`
 filters behavior when enabled.

 If the flag is not set (default), the filter will use the HTTP Host header
 for DNS resolution, maintaining backward compatibility.
      bool allow_dynamic_host_from_filter_state = 4;
      Returns:
      This builder for chaining.

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