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

Class FilterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.dynamic_forward_proxy.v3.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 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FilterConfig.Builder
    Configuration for the dynamic forward proxy HTTP filter.
    static enum 
    FilterConfig.ImplementationSpecifierCase
     

    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
    ALLOW_DYNAMIC_HOST_FROM_FILTER_STATE_FIELD_NUMBER
     
    static final int
    DNS_CACHE_CONFIG_FIELD_NUMBER
     
    static final int
    SAVE_UPSTREAM_ADDRESS_FIELD_NUMBER
     
    static final int
    SUB_CLUSTER_CONFIG_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)
     
    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.
    static FilterConfig
    getDefaultInstance()
     
    FilterConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DnsCacheConfig
    getDnsCacheConfig()
    The DNS cache configuration that the filter will attach to.
    DnsCacheConfigOrBuilder
    getDnsCacheConfigOrBuilder()
    The DNS cache configuration that the filter will attach to.
    FilterConfig.ImplementationSpecifierCase
    getImplementationSpecifierCase()
     
    com.google.protobuf.Parser<FilterConfig>
    getParserForType()
     
    boolean
    getSaveUpstreamAddress()
    When this flag is set, the filter will add the resolved upstream address in the filter state.
    int
    getSerializedSize()
     
    SubClusterConfig
    getSubClusterConfig()
    The configuration that the filter will use, when the related dynamic forward proxy cluster enabled sub clusters.
    SubClusterConfigOrBuilder
    getSubClusterConfigOrBuilder()
    The configuration that the filter will use, when the related dynamic forward proxy cluster enabled sub clusters.
    boolean
    hasDnsCacheConfig()
    The DNS cache configuration that the filter will attach to.
    int
    hashCode()
     
    boolean
    hasSubClusterConfig()
    The configuration that the filter will use, when the related dynamic forward proxy cluster enabled sub clusters.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FilterConfig.Builder
    newBuilder()
     
    static FilterConfig.Builder
    newBuilder(FilterConfig prototype)
     
    FilterConfig.Builder
    newBuilderForType()
     
    protected FilterConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FilterConfig
    parseDelimitedFrom(InputStream input)
     
    static FilterConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(byte[] data)
     
    static FilterConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static FilterConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FilterConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(InputStream input)
     
    static FilterConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FilterConfig
    parseFrom(ByteBuffer data)
     
    static FilterConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FilterConfig>
    parser()
     
    FilterConfig.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

    • DNS_CACHE_CONFIG_FIELD_NUMBER

      public static final int DNS_CACHE_CONFIG_FIELD_NUMBER
      See Also:

    • SUB_CLUSTER_CONFIG_FIELD_NUMBER

      public static final int SUB_CLUSTER_CONFIG_FIELD_NUMBER
      See Also:

    • SAVE_UPSTREAM_ADDRESS_FIELD_NUMBER

      public static final int SAVE_UPSTREAM_ADDRESS_FIELD_NUMBER
      See Also:

    • ALLOW_DYNAMIC_HOST_FROM_FILTER_STATE_FIELD_NUMBER

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

    • getImplementationSpecifierCase

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

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

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

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

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static FilterConfig.Builder newBuilder()

    • newBuilder

      public static FilterConfig.Builder newBuilder(FilterConfig prototype)

    • 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