Package io.envoyproxy.envoy.config.common.matcher.v3

Class HttpGenericBodyMatch

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.common.matcher.v3.HttpGenericBodyMatch

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpGenericBodyMatchOrBuilder, Serializable

public final class HttpGenericBodyMatch
extends com.google.protobuf.GeneratedMessageV3
implements HttpGenericBodyMatchOrBuilder

 HTTP generic body match configuration.
 List of text strings and hex strings to be located in HTTP body.
 All specified strings must be found in the HTTP body for positive match.
 The search may be limited to specified number of bytes from the body start.
 .. attention::
   Searching for patterns in HTTP body is potentially cpu intensive. For each specified pattern, http body is scanned byte by byte to find a match.
   If multiple patterns are specified, the process is repeated for each pattern. If location of a pattern is known, ``bytes_limit`` should be specified
   to scan only part of the http body.
 

Protobuf type envoy.config.common.matcher.v3.HttpGenericBodyMatch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpGenericBodyMatch.Builder	HTTP generic body match configuration.
static class	HttpGenericBodyMatch.GenericTextMatch	Protobuf type envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch
static interface	HttpGenericBodyMatch.GenericTextMatchOrBuilder

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

Field Summary

Fields

Modifier and Type	Field	Description
static int	BYTES_LIMIT_FIELD_NUMBER
static int	PATTERNS_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)
int	getBytesLimit()	Limits search to specified number of bytes - default zero (no limit - match entire captured buffer).
static HttpGenericBodyMatch	getDefaultInstance()
HttpGenericBodyMatch	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<HttpGenericBodyMatch>	getParserForType()
HttpGenericBodyMatch.GenericTextMatch	getPatterns(int index)	List of patterns to match.
int	getPatternsCount()	List of patterns to match.
List<HttpGenericBodyMatch.GenericTextMatch>	getPatternsList()	List of patterns to match.
HttpGenericBodyMatch.GenericTextMatchOrBuilder	getPatternsOrBuilder(int index)	List of patterns to match.
List<? extends HttpGenericBodyMatch.GenericTextMatchOrBuilder>	getPatternsOrBuilderList()	List of patterns to match.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HttpGenericBodyMatch.Builder	newBuilder()
static HttpGenericBodyMatch.Builder	newBuilder(HttpGenericBodyMatch prototype)
HttpGenericBodyMatch.Builder	newBuilderForType()
protected HttpGenericBodyMatch.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static HttpGenericBodyMatch	parseDelimitedFrom(InputStream input)
static HttpGenericBodyMatch	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpGenericBodyMatch	parseFrom(byte[] data)
static HttpGenericBodyMatch	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpGenericBodyMatch	parseFrom(com.google.protobuf.ByteString data)
static HttpGenericBodyMatch	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpGenericBodyMatch	parseFrom(com.google.protobuf.CodedInputStream input)
static HttpGenericBodyMatch	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpGenericBodyMatch	parseFrom(InputStream input)
static HttpGenericBodyMatch	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HttpGenericBodyMatch	parseFrom(ByteBuffer data)
static HttpGenericBodyMatch	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HttpGenericBodyMatch>	parser()
HttpGenericBodyMatch.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

Field Detail

BYTES_LIMIT_FIELD_NUMBER

public static final int BYTES_LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

PATTERNS_FIELD_NUMBER

public static final int PATTERNS_FIELD_NUMBER

See Also:

Constant Field Values

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

getBytesLimit

public int getBytesLimit()

 Limits search to specified number of bytes - default zero (no limit - match entire captured buffer).
 

uint32 bytes_limit = 1;

Specified by:

getBytesLimit in interface HttpGenericBodyMatchOrBuilder

Returns:

The bytesLimit.

getPatternsList

public List<HttpGenericBodyMatch.GenericTextMatch> getPatternsList()

 List of patterns to match.
 

repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }

Specified by:

getPatternsList in interface HttpGenericBodyMatchOrBuilder

getPatternsOrBuilderList

public List<? extends HttpGenericBodyMatch.GenericTextMatchOrBuilder> getPatternsOrBuilderList()

 List of patterns to match.
 

repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }

Specified by:

getPatternsOrBuilderList in interface HttpGenericBodyMatchOrBuilder

getPatternsCount

public int getPatternsCount()

 List of patterns to match.
 

repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }

Specified by:

getPatternsCount in interface HttpGenericBodyMatchOrBuilder

getPatterns

public HttpGenericBodyMatch.GenericTextMatch getPatterns(int index)

 List of patterns to match.
 

repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }

Specified by:

getPatterns in interface HttpGenericBodyMatchOrBuilder

getPatternsOrBuilder

public HttpGenericBodyMatch.GenericTextMatchOrBuilder getPatternsOrBuilder(int index)

 List of patterns to match.
 

repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }

Specified by:

getPatternsOrBuilder in interface HttpGenericBodyMatchOrBuilder

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 HttpGenericBodyMatch parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpGenericBodyMatch parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpGenericBodyMatch parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HttpGenericBodyMatch parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static HttpGenericBodyMatch parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static HttpGenericBodyMatch parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public HttpGenericBodyMatch.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static HttpGenericBodyMatch.Builder newBuilder()

newBuilder

public static HttpGenericBodyMatch.Builder newBuilder(HttpGenericBodyMatch prototype)

toBuilder

public HttpGenericBodyMatch.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected HttpGenericBodyMatch.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static HttpGenericBodyMatch getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<HttpGenericBodyMatch> 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 HttpGenericBodyMatch getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder