Class HttpFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpFilterOrBuilder, Serializable
@Generated public final class HttpFilter extends com.google.protobuf.GeneratedMessage implements HttpFilterOrBuilder
[#next-free-field: 8]
Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    HttpFilter.Builder
    [#next-free-field: 8]
    static enum 
    HttpFilter.ConfigTypeCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    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
    CONFIG_DISCOVERY_FIELD_NUMBER
     
    private Object
    configType_
     
    private int
    configTypeCase_
     
    private static final HttpFilter
    DEFAULT_INSTANCE
     
    private boolean
    disabled_
     
    static final int
    DISABLED_FIELD_NUMBER
     
    static final int
    IS_OPTIONAL_FIELD_NUMBER
     
    private boolean
    isOptional_
     
    private byte
    memoizedIsInitialized
     
    private Object
    name_
     
    static final int
    NAME_FIELD_NUMBER
     
    private static final com.google.protobuf.Parser<HttpFilter>
    PARSER
     
    private static final long
    serialVersionUID
     
    static final int
    TYPED_CONFIG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    HttpFilter()
     
    private
    HttpFilter(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    ExtensionConfigSource
    getConfigDiscovery()
    Configuration source specifier for an extension configuration discovery service.
    ExtensionConfigSourceOrBuilder
    getConfigDiscoveryOrBuilder()
    Configuration source specifier for an extension configuration discovery service.
    HttpFilter.ConfigTypeCase
    getConfigTypeCase()
     
    static HttpFilter
    getDefaultInstance()
     
    HttpFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    boolean
    getDisabled()
    If true, the filter is disabled by default and must be explicitly enabled by setting per filter configuration in the route configuration.
    boolean
    getIsOptional()
    If true, clients that do not support this filter may ignore the filter but otherwise accept the config.
    String
    getName()
    The name of the filter configuration.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the filter configuration.
    com.google.protobuf.Parser<HttpFilter>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.Any
    getTypedConfig()
    Filter specific configuration which depends on the filter being instantiated.
    com.google.protobuf.AnyOrBuilder
    getTypedConfigOrBuilder()
    Filter specific configuration which depends on the filter being instantiated.
    boolean
    hasConfigDiscovery()
    Configuration source specifier for an extension configuration discovery service.
    int
    hashCode()
     
    boolean
    hasTypedConfig()
    Filter specific configuration which depends on the filter being instantiated.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static HttpFilter.Builder
    newBuilder()
     
    static HttpFilter.Builder
    newBuilder(HttpFilter prototype)
     
    HttpFilter.Builder
    newBuilderForType()
     
    protected HttpFilter.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static HttpFilter
    parseDelimitedFrom(InputStream input)
     
    static HttpFilter
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpFilter
    parseFrom(byte[] data)
     
    static HttpFilter
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpFilter
    parseFrom(com.google.protobuf.ByteString data)
     
    static HttpFilter
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpFilter
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static HttpFilter
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpFilter
    parseFrom(InputStream input)
     
    static HttpFilter
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpFilter
    parseFrom(ByteBuffer data)
     
    static HttpFilter
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<HttpFilter>
    parser()
     
    HttpFilter.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • configTypeCase_

      private int configTypeCase_

    • configType_

      private Object configType_

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • name_

      private volatile Object name_

    • TYPED_CONFIG_FIELD_NUMBER

      public static final int TYPED_CONFIG_FIELD_NUMBER
      See Also:

    • CONFIG_DISCOVERY_FIELD_NUMBER

      public static final int CONFIG_DISCOVERY_FIELD_NUMBER
      See Also:

    • IS_OPTIONAL_FIELD_NUMBER

      public static final int IS_OPTIONAL_FIELD_NUMBER
      See Also:

    • isOptional_

      private boolean isOptional_

    • DISABLED_FIELD_NUMBER

      public static final int DISABLED_FIELD_NUMBER
      See Also:

    • disabled_

      private boolean disabled_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final HttpFilter DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<HttpFilter> PARSER

  • Constructor Details

    • HttpFilter

      private HttpFilter(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • HttpFilter

      private HttpFilter()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getConfigTypeCase

      public HttpFilter.ConfigTypeCase getConfigTypeCase()
      Specified by:
      getConfigTypeCase in interface HttpFilterOrBuilder

    • getName

      public String getName()
      The name of the filter configuration. It also serves as a resource name in ExtensionConfigDS.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getName in interface HttpFilterOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      The name of the filter configuration. It also serves as a resource name in ExtensionConfigDS.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getNameBytes in interface HttpFilterOrBuilder
      Returns:
      The bytes for name.

    • hasTypedConfig

      public boolean hasTypedConfig()
      Filter specific configuration which depends on the filter being instantiated. See the supported
filters for further documentation.

To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
:ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
with the desired HTTP filter.
[#extension-category: envoy.filters.http]
      .google.protobuf.Any typed_config = 4;
      Specified by:
      hasTypedConfig in interface HttpFilterOrBuilder
      Returns:
      Whether the typedConfig field is set.

    • getTypedConfig

      public com.google.protobuf.Any getTypedConfig()
      Filter specific configuration which depends on the filter being instantiated. See the supported
filters for further documentation.

To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
:ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
with the desired HTTP filter.
[#extension-category: envoy.filters.http]
      .google.protobuf.Any typed_config = 4;
      Specified by:
      getTypedConfig in interface HttpFilterOrBuilder
      Returns:
      The typedConfig.

    • getTypedConfigOrBuilder

      public com.google.protobuf.AnyOrBuilder getTypedConfigOrBuilder()
      Filter specific configuration which depends on the filter being instantiated. See the supported
filters for further documentation.

To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
:ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
with the desired HTTP filter.
[#extension-category: envoy.filters.http]
      .google.protobuf.Any typed_config = 4;
      Specified by:
      getTypedConfigOrBuilder in interface HttpFilterOrBuilder

    • hasConfigDiscovery

      public boolean hasConfigDiscovery()
      Configuration source specifier for an extension configuration discovery service.
In case of a failure and without the default configuration, the HTTP listener responds with code 500.
Extension configs delivered through this mechanism are not expected to require warming (see https://github.com/envoyproxy/envoy/issues/12061).

To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
:ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
with the desired HTTP filter. This works for both the default filter configuration as well
as for filters provided via the API.
      .envoy.config.core.v3.ExtensionConfigSource config_discovery = 5;
      Specified by:
      hasConfigDiscovery in interface HttpFilterOrBuilder
      Returns:
      Whether the configDiscovery field is set.

    • getConfigDiscovery

      public ExtensionConfigSource getConfigDiscovery()
      Configuration source specifier for an extension configuration discovery service.
In case of a failure and without the default configuration, the HTTP listener responds with code 500.
Extension configs delivered through this mechanism are not expected to require warming (see https://github.com/envoyproxy/envoy/issues/12061).

To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
:ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
with the desired HTTP filter. This works for both the default filter configuration as well
as for filters provided via the API.
      .envoy.config.core.v3.ExtensionConfigSource config_discovery = 5;
      Specified by:
      getConfigDiscovery in interface HttpFilterOrBuilder
      Returns:
      The configDiscovery.

    • getConfigDiscoveryOrBuilder

      public ExtensionConfigSourceOrBuilder getConfigDiscoveryOrBuilder()
      Configuration source specifier for an extension configuration discovery service.
In case of a failure and without the default configuration, the HTTP listener responds with code 500.
Extension configs delivered through this mechanism are not expected to require warming (see https://github.com/envoyproxy/envoy/issues/12061).

To support configuring a :ref:`match tree <arch_overview_matching_api>`, use an
:ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>`
with the desired HTTP filter. This works for both the default filter configuration as well
as for filters provided via the API.
      .envoy.config.core.v3.ExtensionConfigSource config_discovery = 5;
      Specified by:
      getConfigDiscoveryOrBuilder in interface HttpFilterOrBuilder

    • getIsOptional

      public boolean getIsOptional()
      If true, clients that do not support this filter may ignore the
filter but otherwise accept the config.
Otherwise, clients that do not support this filter must reject the config.
      bool is_optional = 6;
      Specified by:
      getIsOptional in interface HttpFilterOrBuilder
      Returns:
      The isOptional.

    • getDisabled

      public boolean getDisabled()
      If true, the filter is disabled by default and must be explicitly enabled by setting
per filter configuration in the route configuration.
See :ref:`route based filter chain <arch_overview_http_filters_route_based_filter_chain>`
for more details.

Terminal filters (e.g. ``envoy.filters.http.router``) cannot be marked as disabled.
      bool disabled = 7;
      Specified by:
      getDisabled in interface HttpFilterOrBuilder
      Returns:
      The disabled.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static HttpFilter.Builder newBuilder()

    • newBuilder

      public static HttpFilter.Builder newBuilder(HttpFilter prototype)

    • toBuilder

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

    • newBuilderForType

      protected HttpFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static HttpFilter getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<HttpFilter> 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.GeneratedMessage

    • getDefaultInstanceForType

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