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
,java.io.Serializable
public final class HttpFilter extends com.google.protobuf.GeneratedMessage implements HttpFilterOrBuilder
[#next-free-field: 8]
Protobuf typeenvoy.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: 8]static class
HttpFilter.ConfigTypeCase
-
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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
CONFIG_DISCOVERY_FIELD_NUMBER
private java.lang.Object
configType_
private int
configTypeCase_
private static HttpFilter
DEFAULT_INSTANCE
private boolean
disabled_
static int
DISABLED_FIELD_NUMBER
static int
IS_OPTIONAL_FIELD_NUMBER
private boolean
isOptional_
private byte
memoizedIsInitialized
private java.lang.Object
name_
static int
NAME_FIELD_NUMBER
private static com.google.protobuf.Parser<HttpFilter>
PARSER
private static long
serialVersionUID
static int
TYPED_CONFIG_FIELD_NUMBER
-
Constructor Summary
Constructors Modifier Constructor Description private
HttpFilter()
private
HttpFilter(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.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 com.google.protobuf.Descriptors.Descriptor
getDescriptor()
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.java.lang.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()
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(java.io.InputStream input)
static HttpFilter
parseDelimitedFrom(java.io.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(java.io.InputStream input)
static HttpFilter
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpFilter
parseFrom(java.nio.ByteBuffer data)
static HttpFilter
parseFrom(java.nio.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
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
configTypeCase_
private int configTypeCase_
-
configType_
private java.lang.Object configType_
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
name_
private volatile java.lang.Object name_
-
TYPED_CONFIG_FIELD_NUMBER
public static final int TYPED_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONFIG_DISCOVERY_FIELD_NUMBER
public static final int CONFIG_DISCOVERY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IS_OPTIONAL_FIELD_NUMBER
public static final int IS_OPTIONAL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
isOptional_
private boolean isOptional_
-
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
- See Also:
- Constant Field Values
-
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
-
-
Method Detail
-
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
public HttpFilter.ConfigTypeCase getConfigTypeCase()
- Specified by:
getConfigTypeCase
in interfaceHttpFilterOrBuilder
-
getName
public java.lang.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 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
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 interfaceHttpFilterOrBuilder
- 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 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
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- 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(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static HttpFilter parseFrom(java.nio.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(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static HttpFilter parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static HttpFilter parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static HttpFilter parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static HttpFilter parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static HttpFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public HttpFilter.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.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 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
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 interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public HttpFilter getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-