io.envoyproxy.envoy.config.route.v3

Interface HeaderMatcherOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HeaderMatcher, HeaderMatcher.Builder

public interface HeaderMatcherOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Specifies the name of the header in the request.
 

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

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Specifies the name of the header in the request.
 

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

getExactMatch

String getExactMatch()

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

string exact_match = 4;

getExactMatchBytes

com.google.protobuf.ByteString getExactMatchBytes()

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

string exact_match = 4;

hasSafeRegexMatch

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;

getSafeRegexMatch

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;

getSafeRegexMatchOrBuilder

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;

hasRangeMatch

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;

getRangeMatch

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;

getRangeMatchOrBuilder

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;

getPresentMatch

boolean getPresentMatch()

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

bool present_match = 7;

getPrefixMatch

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) = { ... }

getPrefixMatchBytes

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) = { ... }

getSuffixMatch

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) = { ... }

getSuffixMatchBytes

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) = { ... }

getContainsMatch

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) = { ... }

getContainsMatchBytes

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) = { ... }

getInvertMatch

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;

getHeaderMatchSpecifierCase

HeaderMatcher.HeaderMatchSpecifierCase getHeaderMatchSpecifierCase()