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
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 ClassesModifier and TypeClassDescriptionstatic final class
[#next-free-field: 8]static enum
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, 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
FieldsModifier and TypeFieldDescriptionstatic final int
private Object
private int
private static final HttpFilter
private boolean
static final int
static final int
private boolean
private byte
private Object
static final int
private static final com.google.protobuf.Parser
<HttpFilter> private static final long
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
HttpFilter
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Configuration source specifier for an extension configuration discovery service.Configuration source specifier for an extension configuration discovery service.static HttpFilter
static final com.google.protobuf.Descriptors.Descriptor
boolean
If true, the filter is disabled by default and must be explicitly enabled by setting per filter configuration in the route configuration.boolean
If true, clients that do not support this filter may ignore the filter but otherwise accept the config.getName()
The name of the filter configuration.com.google.protobuf.ByteString
The name of the filter configuration.com.google.protobuf.Parser
<HttpFilter> int
com.google.protobuf.Any
Filter specific configuration which depends on the filter being instantiated.com.google.protobuf.AnyOrBuilder
Filter specific configuration which depends on the filter being instantiated.boolean
Configuration source specifier for an extension configuration discovery service.int
hashCode()
boolean
Filter specific configuration which depends on the filter being instantiated.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static HttpFilter.Builder
static HttpFilter.Builder
newBuilder
(HttpFilter prototype) 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()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, 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 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
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
configTypeCase_
private int configTypeCase_ -
configType_
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
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
-
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() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getConfigTypeCase
- Specified by:
getConfigTypeCase
in interfaceHttpFilterOrBuilder
-
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 interfaceHttpFilterOrBuilder
- 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 interfaceHttpFilterOrBuilder
- 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 interfaceHttpFilterOrBuilder
- 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 interfaceHttpFilterOrBuilder
- 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 interfaceHttpFilterOrBuilder
-
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 interfaceHttpFilterOrBuilder
- Returns:
- Whether the configDiscovery field is set.
-
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 interfaceHttpFilterOrBuilder
- Returns:
- The configDiscovery.
-
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 interfaceHttpFilterOrBuilder
-
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 interfaceHttpFilterOrBuilder
- 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 interfaceHttpFilterOrBuilder
- Returns:
- The disabled.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static HttpFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static HttpFilter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static HttpFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HttpFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-