io.envoyproxy.envoy.config.route.v3

Class HeaderMatcher

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.route.v3.HeaderMatcher

All Implemented Interfaces:

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

public final class HeaderMatcher
extends com.google.protobuf.GeneratedMessageV3
implements HeaderMatcherOrBuilder

 .. attention::
   Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host*
   header. Thus, if attempting to match on *Host*, match on *:authority* instead.
 .. attention::
   To route on HTTP method, use the special HTTP/2 *:method* header. This works for both
   HTTP/1 and HTTP/2 as Envoy normalizes headers. E.g.,
   .. code-block:: json
     {
       "name": ":method",
       "exact_match": "POST"
     }
 .. attention::
   In the absence of any header match specifier, match will default to :ref:`present_match
   <envoy_api_field_config.route.v3.HeaderMatcher.present_match>`. i.e, a request that has the :ref:`name
   <envoy_api_field_config.route.v3.HeaderMatcher.name>` header will match, regardless of the header's
   value.
  [#next-major-version: HeaderMatcher should be refactored to use StringMatcher.]
 [#next-free-field: 13]
 

Protobuf type envoy.config.route.v3.HeaderMatcher

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeaderMatcher.Builder .. attention:: Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host* header.
static class	HeaderMatcher.HeaderMatchSpecifierCase

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINS_MATCH_FIELD_NUMBER
static int	EXACT_MATCH_FIELD_NUMBER
static int	INVERT_MATCH_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PREFIX_MATCH_FIELD_NUMBER
static int	PRESENT_MATCH_FIELD_NUMBER
static int	RANGE_MATCH_FIELD_NUMBER
static int	SAFE_REGEX_MATCH_FIELD_NUMBER
static int	SUFFIX_MATCH_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 and Description
boolean	equals(Object obj)
String	getContainsMatch() If specified, header match will be performed based on whether the header value contains the given value or not.
com.google.protobuf.ByteString	getContainsMatchBytes() If specified, header match will be performed based on whether the header value contains the given value or not.
static HeaderMatcher	getDefaultInstance()
HeaderMatcher	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getExactMatch() If specified, header match will be performed based on the value of the header.
com.google.protobuf.ByteString	getExactMatchBytes() If specified, header match will be performed based on the value of the header.
HeaderMatcher.HeaderMatchSpecifierCase	getHeaderMatchSpecifierCase()
boolean	getInvertMatch() If specified, the match result will be inverted before checking.
String	getName() Specifies the name of the header in the request.
com.google.protobuf.ByteString	getNameBytes() Specifies the name of the header in the request.
com.google.protobuf.Parser<HeaderMatcher>	getParserForType()
String	getPrefixMatch() If specified, header match will be performed based on the prefix of the header value.
com.google.protobuf.ByteString	getPrefixMatchBytes() If specified, header match will be performed based on the prefix of the header value.
boolean	getPresentMatch() If specified, header match will be performed based on whether the header is in the request.
Int64Range	getRangeMatch() If specified, header match will be performed based on range.
Int64RangeOrBuilder	getRangeMatchOrBuilder() If specified, header match will be performed based on range.
RegexMatcher	getSafeRegexMatch() If specified, this regex string is a regular expression rule which implies the entire request header value must match the regex.
RegexMatcherOrBuilder	getSafeRegexMatchOrBuilder() If specified, this regex string is a regular expression rule which implies the entire request header value must match the regex.
int	getSerializedSize()
String	getSuffixMatch() If specified, header match will be performed based on the suffix of the header value.
com.google.protobuf.ByteString	getSuffixMatchBytes() If specified, header match will be performed based on the suffix of the header value.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasRangeMatch() If specified, header match will be performed based on range.
boolean	hasSafeRegexMatch() If specified, this regex string is a regular expression rule which implies the entire request header value must match the regex.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HeaderMatcher.Builder	newBuilder()
static HeaderMatcher.Builder	newBuilder(HeaderMatcher prototype)
HeaderMatcher.Builder	newBuilderForType()
protected HeaderMatcher.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static HeaderMatcher	parseDelimitedFrom(InputStream input)
static HeaderMatcher	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HeaderMatcher	parseFrom(byte[] data)
static HeaderMatcher	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HeaderMatcher	parseFrom(ByteBuffer data)
static HeaderMatcher	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HeaderMatcher	parseFrom(com.google.protobuf.ByteString data)
static HeaderMatcher	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HeaderMatcher	parseFrom(com.google.protobuf.CodedInputStream input)
static HeaderMatcher	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HeaderMatcher	parseFrom(InputStream input)
static HeaderMatcher	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HeaderMatcher>	parser()
HeaderMatcher.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, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

EXACT_MATCH_FIELD_NUMBER

public static final int EXACT_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

SAFE_REGEX_MATCH_FIELD_NUMBER

public static final int SAFE_REGEX_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

RANGE_MATCH_FIELD_NUMBER

public static final int RANGE_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

PRESENT_MATCH_FIELD_NUMBER

public static final int PRESENT_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

PREFIX_MATCH_FIELD_NUMBER

public static final int PREFIX_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

SUFFIX_MATCH_FIELD_NUMBER

public static final int SUFFIX_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

CONTAINS_MATCH_FIELD_NUMBER

public static final int CONTAINS_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

INVERT_MATCH_FIELD_NUMBER

public static final int INVERT_MATCH_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

getHeaderMatchSpecifierCase

public HeaderMatcher.HeaderMatchSpecifierCase getHeaderMatchSpecifierCase()

Specified by:

getHeaderMatchSpecifierCase in interface HeaderMatcherOrBuilder

getName

public String getName()

 Specifies the name of the header in the request.
 

string name = 1 [(.validate.rules) = { ... }

Specified by:

getName in interface HeaderMatcherOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Specifies the name of the header in the request.
 

string name = 1 [(.validate.rules) = { ... }

Specified by:

getNameBytes in interface HeaderMatcherOrBuilder

getExactMatch

public String getExactMatch()

 If specified, header match will be performed based on the value of the header.
 

string exact_match = 4;

Specified by:

getExactMatch in interface HeaderMatcherOrBuilder

getExactMatchBytes

public com.google.protobuf.ByteString getExactMatchBytes()

 If specified, header match will be performed based on the value of the header.
 

string exact_match = 4;

Specified by:

getExactMatchBytes in interface HeaderMatcherOrBuilder

hasSafeRegexMatch

public boolean hasSafeRegexMatch()

 If specified, this regex string is a regular expression rule which implies the entire request
 header value must match the regex. The rule will not match if only a subsequence of the
 request header value matches the regex.
 

.envoy.type.matcher.v3.RegexMatcher safe_regex_match = 11;

Specified by:

hasSafeRegexMatch in interface HeaderMatcherOrBuilder

getSafeRegexMatch

public RegexMatcher getSafeRegexMatch()

 If specified, this regex string is a regular expression rule which implies the entire request
 header value must match the regex. The rule will not match if only a subsequence of the
 request header value matches the regex.
 

.envoy.type.matcher.v3.RegexMatcher safe_regex_match = 11;

Specified by:

getSafeRegexMatch in interface HeaderMatcherOrBuilder

getSafeRegexMatchOrBuilder

public RegexMatcherOrBuilder getSafeRegexMatchOrBuilder()

 If specified, this regex string is a regular expression rule which implies the entire request
 header value must match the regex. The rule will not match if only a subsequence of the
 request header value matches the regex.
 

.envoy.type.matcher.v3.RegexMatcher safe_regex_match = 11;

Specified by:

getSafeRegexMatchOrBuilder in interface HeaderMatcherOrBuilder

hasRangeMatch

public boolean hasRangeMatch()

 If specified, header match will be performed based on range.
 The rule will match if the request header value is within this range.
 The entire request header value must represent an integer in base 10 notation: consisting of
 an optional plus or minus sign followed by a sequence of digits. The rule will not match if
 the header value does not represent an integer. Match will fail for empty values, floating
 point numbers or if only a subsequence of the header value is an integer.
 Examples:
 * For range [-10,0), route will match for header value -1, but not for 0, "somestring", 10.9,
   "-1somestring"
 

.envoy.type.v3.Int64Range range_match = 6;

Specified by:

hasRangeMatch in interface HeaderMatcherOrBuilder

getRangeMatch

public Int64Range getRangeMatch()

 If specified, header match will be performed based on range.
 The rule will match if the request header value is within this range.
 The entire request header value must represent an integer in base 10 notation: consisting of
 an optional plus or minus sign followed by a sequence of digits. The rule will not match if
 the header value does not represent an integer. Match will fail for empty values, floating
 point numbers or if only a subsequence of the header value is an integer.
 Examples:
 * For range [-10,0), route will match for header value -1, but not for 0, "somestring", 10.9,
   "-1somestring"
 

.envoy.type.v3.Int64Range range_match = 6;

Specified by:

getRangeMatch in interface HeaderMatcherOrBuilder

getRangeMatchOrBuilder

public Int64RangeOrBuilder getRangeMatchOrBuilder()

 If specified, header match will be performed based on range.
 The rule will match if the request header value is within this range.
 The entire request header value must represent an integer in base 10 notation: consisting of
 an optional plus or minus sign followed by a sequence of digits. The rule will not match if
 the header value does not represent an integer. Match will fail for empty values, floating
 point numbers or if only a subsequence of the header value is an integer.
 Examples:
 * For range [-10,0), route will match for header value -1, but not for 0, "somestring", 10.9,
   "-1somestring"
 

.envoy.type.v3.Int64Range range_match = 6;

Specified by:

getRangeMatchOrBuilder in interface HeaderMatcherOrBuilder

getPresentMatch

public boolean getPresentMatch()

 If specified, header match will be performed based on whether the header is in the
 request.
 

bool present_match = 7;

Specified by:

getPresentMatch in interface HeaderMatcherOrBuilder

getPrefixMatch

public String getPrefixMatch()

 If specified, header match will be performed based on the prefix of the header value.
 Note: empty prefix is not allowed, please use present_match instead.
 Examples:
 * The prefix *abcd* matches the value *abcdxyz*, but not for *abcxyz*.
 

string prefix_match = 9 [(.validate.rules) = { ... }

Specified by:

getPrefixMatch in interface HeaderMatcherOrBuilder

getPrefixMatchBytes

public com.google.protobuf.ByteString getPrefixMatchBytes()

 If specified, header match will be performed based on the prefix of the header value.
 Note: empty prefix is not allowed, please use present_match instead.
 Examples:
 * The prefix *abcd* matches the value *abcdxyz*, but not for *abcxyz*.
 

string prefix_match = 9 [(.validate.rules) = { ... }

Specified by:

getPrefixMatchBytes in interface HeaderMatcherOrBuilder

getSuffixMatch

public String getSuffixMatch()

 If specified, header match will be performed based on the suffix of the header value.
 Note: empty suffix is not allowed, please use present_match instead.
 Examples:
 * The suffix *abcd* matches the value *xyzabcd*, but not for *xyzbcd*.
 

string suffix_match = 10 [(.validate.rules) = { ... }

Specified by:

getSuffixMatch in interface HeaderMatcherOrBuilder

getSuffixMatchBytes

public com.google.protobuf.ByteString getSuffixMatchBytes()

 If specified, header match will be performed based on the suffix of the header value.
 Note: empty suffix is not allowed, please use present_match instead.
 Examples:
 * The suffix *abcd* matches the value *xyzabcd*, but not for *xyzbcd*.
 

string suffix_match = 10 [(.validate.rules) = { ... }

Specified by:

getSuffixMatchBytes in interface HeaderMatcherOrBuilder

getContainsMatch

public String getContainsMatch()

 If specified, header match will be performed based on whether the header value contains
 the given value or not.
 Note: empty contains match is not allowed, please use present_match instead.
 Examples:
 * The value *abcd* matches the value *xyzabcdpqr*, but not for *xyzbcdpqr*.
 

string contains_match = 12 [(.validate.rules) = { ... }

Specified by:

getContainsMatch in interface HeaderMatcherOrBuilder

getContainsMatchBytes

public com.google.protobuf.ByteString getContainsMatchBytes()

 If specified, header match will be performed based on whether the header value contains
 the given value or not.
 Note: empty contains match is not allowed, please use present_match instead.
 Examples:
 * The value *abcd* matches the value *xyzabcdpqr*, but not for *xyzbcdpqr*.
 

string contains_match = 12 [(.validate.rules) = { ... }

Specified by:

getContainsMatchBytes in interface HeaderMatcherOrBuilder

getInvertMatch

public boolean getInvertMatch()

 If specified, the match result will be inverted before checking. Defaults to false.
 Examples:
 * The regex ``\d{3}`` does not match the value *1234*, so it will match when inverted.
 * The range [-10,0) will match the value -1, so it will not match when inverted.
 

bool invert_match = 8;

Specified by:

getInvertMatch in interface HeaderMatcherOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HeaderMatcher parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static HeaderMatcher parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public HeaderMatcher.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static HeaderMatcher.Builder newBuilder()

newBuilder

public static HeaderMatcher.Builder newBuilder(HeaderMatcher prototype)

toBuilder

public HeaderMatcher.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static HeaderMatcher getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder