Package io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3

Class HttpFilter

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpFilterOrBuilder, Serializable
    public final class HttpFilter
extends com.google.protobuf.GeneratedMessageV3
implements HttpFilterOrBuilder
     [#next-free-field: 7]
    Protobuf type envoy.extensions.filters.network.http_connection_manager.v3.HttpFilter
    See Also:
    Serialized Form

    • Nested Class Summary

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

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • 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

      • 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.
 This is also same with typed per filter config.
        bool is_optional = 6;
        Specified by:
        getIsOptional in interface HttpFilterOrBuilder
        Returns:
        The isOptional.

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

      • getDefaultInstanceForType

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