envoy.api.v2.route

Interface RouteOuterClass.HeaderMatcherOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RouteOuterClass.HeaderMatcher, RouteOuterClass.HeaderMatcher.Builder

Enclosing class:

RouteOuterClass

public static interface RouteOuterClass.HeaderMatcherOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
RouteOuterClass.HeaderMatcher.HeaderMatchSpecifierCase	getHeaderMatchSpecifierCase()
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.
Range.Int64Range	getRangeMatch() If specified, header match will be performed based on range.
Range.Int64RangeOrBuilder	getRangeMatchOrBuilder() If specified, header match will be performed based on range.
com.google.protobuf.BoolValue	getRegex() Specifies whether the header value is a regular expression or not.
String	getRegexMatch() If specified, this regex string is a regular expression rule which implies the entire request header value must match the regex.
com.google.protobuf.ByteString	getRegexMatchBytes() If specified, this regex string is a regular expression rule which implies the entire request header value must match the regex.
com.google.protobuf.BoolValueOrBuilder	getRegexOrBuilder() Specifies whether the header value is a regular expression or not.
String	getValue() Specifies the value of the header.
com.google.protobuf.ByteString	getValueBytes() Specifies the value of the header.
boolean	hasRangeMatch() If specified, header match will be performed based on range.
boolean	hasRegex() Specifies whether the header value is a regular expression or not.

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

getValue

String getValue()

 Specifies the value of the header. If the value is absent a request that
 has the name header will match, regardless of the header’s value.
 

string value = 2;

getValueBytes

com.google.protobuf.ByteString getValueBytes()

 Specifies the value of the header. If the value is absent a request that
 has the name header will match, regardless of the header’s value.
 

string value = 2;

hasRegex

boolean hasRegex()

 Specifies whether the header value is a regular
 expression or not. Defaults to false. 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. The
 regex grammar used in the value field is defined
 `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex *\d{3}* matches the value *123*
 * The regex *\d{3}* does not match the value *1234*
 * The regex *\d{3}* does not match the value *123.456*
 

.google.protobuf.BoolValue regex = 3;

getRegex

com.google.protobuf.BoolValue getRegex()

 Specifies whether the header value is a regular
 expression or not. Defaults to false. 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. The
 regex grammar used in the value field is defined
 `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex *\d{3}* matches the value *123*
 * The regex *\d{3}* does not match the value *1234*
 * The regex *\d{3}* does not match the value *123.456*
 

.google.protobuf.BoolValue regex = 3;

getRegexOrBuilder

com.google.protobuf.BoolValueOrBuilder getRegexOrBuilder()

 Specifies whether the header value is a regular
 expression or not. Defaults to false. 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. The
 regex grammar used in the value field is defined
 `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex *\d{3}* matches the value *123*
 * The regex *\d{3}* does not match the value *1234*
 * The regex *\d{3}* does not match the value *123.456*
 

.google.protobuf.BoolValue regex = 3;

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;

getRegexMatch

String getRegexMatch()

 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. The regex grammar used in the value field is defined
 `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex *\d{3}* matches the value *123*
 * The regex *\d{3}* does not match the value *1234*
 * The regex *\d{3}* does not match the value *123.456*
 

string regex_match = 5;

getRegexMatchBytes

com.google.protobuf.ByteString getRegexMatchBytes()

 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. The regex grammar used in the value field is defined
 `here <http://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex *\d{3}* matches the value *123*
 * The regex *\d{3}* does not match the value *1234*
 * The regex *\d{3}* does not match the value *123.456*
 

string regex_match = 5;

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.Int64Range range_match = 6;

getRangeMatch

Range.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.Int64Range range_match = 6;

getRangeMatchOrBuilder

Range.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.Int64Range range_match = 6;

getHeaderMatchSpecifierCase

RouteOuterClass.HeaderMatcher.HeaderMatchSpecifierCase getHeaderMatchSpecifierCase()