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 TypeMethodDescriptionDeprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.boolean
If specified, the match result will be inverted before checking.getName()
Specifies the name of the header in the request.com.google.protobuf.ByteString
Specifies the name of the header in the request.Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.boolean
If specified as true, header match will be performed based on whether the header is in the request.If specified, header match will be performed based on range.If specified, header match will be performed based on range.Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated.Deprecated.If specified, header match will be performed based on the string match of the header value.If specified, header match will be performed based on the string match of the header value.Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.boolean
If specified, for any header match rule, if the header match rule specified header does not exist, this header value will be treated as empty.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.boolean
If specified as true, header match will be performed based on whether the header is in the request.boolean
If specified, header match will be performed based on range.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated.boolean
If specified, header match will be performed based on the string match of the header value.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Specifies the name of the header in the request.
string name = 1 [(.validate.rules) = { ... }
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Specifies the name of the header in the request.
string name = 1 [(.validate.rules) = { ... }
- Returns:
- The bytes for name.
-
hasExactMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2241If specified, header match will be performed based on the value of the header. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
string exact_match = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the exactMatch field is set.
-
getExactMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2241If specified, header match will be performed based on the value of the header. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
string exact_match = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The exactMatch.
-
getExactMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2241If specified, header match will be performed based on the value of the header. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
string exact_match = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The bytes for exactMatch.
-
hasSafeRegexMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2248If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
.envoy.type.matcher.v3.RegexMatcher safe_regex_match = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- Whether the safeRegexMatch field is set.
-
getSafeRegexMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2248If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
.envoy.type.matcher.v3.RegexMatcher safe_regex_match = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The safeRegexMatch.
-
getSafeRegexMatchOrBuilder
Deprecated.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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`.
.envoy.type.matcher.v3.RegexMatcher safe_regex_match = 11 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
-
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;
- Returns:
- Whether the rangeMatch field is set.
-
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;
- Returns:
- The rangeMatch.
-
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;
-
hasPresentMatch
boolean hasPresentMatch()If specified as true, header match will be performed based on whether the header is in the request. If specified as false, header match will be performed based on whether the header is absent.
bool present_match = 7;
- Returns:
- Whether the presentMatch field is set.
-
getPresentMatch
boolean getPresentMatch()If specified as true, header match will be performed based on whether the header is in the request. If specified as false, header match will be performed based on whether the header is absent.
bool present_match = 7;
- Returns:
- The presentMatch.
-
hasPrefixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2275If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The prefix ``abcd`` matches the value ``abcdxyz``, but not for ``abcxyz``.
string prefix_match = 9 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- Whether the prefixMatch field is set.
-
getPrefixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2275If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The prefix ``abcd`` matches the value ``abcdxyz``, but not for ``abcxyz``.
string prefix_match = 9 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- The prefixMatch.
-
getPrefixMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2275If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The prefix ``abcd`` matches the value ``abcdxyz``, but not for ``abcxyz``.
string prefix_match = 9 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- The bytes for prefixMatch.
-
hasSuffixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2288If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The suffix ``abcd`` matches the value ``xyzabcd``, but not for ``xyzbcd``.
string suffix_match = 10 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- Whether the suffixMatch field is set.
-
getSuffixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2288If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The suffix ``abcd`` matches the value ``xyzabcd``, but not for ``xyzbcd``.
string suffix_match = 10 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- The suffixMatch.
-
getSuffixMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2288If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The suffix ``abcd`` matches the value ``xyzabcd``, but not for ``xyzbcd``.
string suffix_match = 10 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- The bytes for suffixMatch.
-
hasContainsMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2302If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The value ``abcd`` matches the value ``xyzabcdpqr``, but not for ``xyzbcdpqr``.
string contains_match = 12 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- Whether the containsMatch field is set.
-
getContainsMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2302If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The value ``abcd`` matches the value ``xyzabcdpqr``, but not for ``xyzbcdpqr``.
string contains_match = 12 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- The containsMatch.
-
getContainsMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2302If 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. This field is deprecated. Please use :ref:`string_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.string_match>`. Examples: * The value ``abcd`` matches the value ``xyzabcdpqr``, but not for ``xyzbcdpqr``.
string contains_match = 12 [deprecated = true, (.validate.rules) = { ... }
- Returns:
- The bytes for containsMatch.
-
hasStringMatch
boolean hasStringMatch()If specified, header match will be performed based on the string match of the header value.
.envoy.type.matcher.v3.StringMatcher string_match = 13;
- Returns:
- Whether the stringMatch field is set.
-
getStringMatch
StringMatcher getStringMatch()If specified, header match will be performed based on the string match of the header value.
.envoy.type.matcher.v3.StringMatcher string_match = 13;
- Returns:
- The stringMatch.
-
getStringMatchOrBuilder
StringMatcherOrBuilder getStringMatchOrBuilder()If specified, header match will be performed based on the string match of the header value.
.envoy.type.matcher.v3.StringMatcher string_match = 13;
-
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;
- Returns:
- The invertMatch.
-
getTreatMissingHeaderAsEmpty
boolean getTreatMissingHeaderAsEmpty()If specified, for any header match rule, if the header match rule specified header does not exist, this header value will be treated as empty. Defaults to false. Examples: * The header match rule specified header "header1" to range match of [0, 10], :ref:`invert_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.invert_match>` is set to true and :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>` is set to true; The "header1" header is not present. The match rule will treat the "header1" as an empty header. The empty header does not match the range, so it will match when inverted. * The header match rule specified header "header2" to range match of [0, 10], :ref:`invert_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.invert_match>` is set to true and :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>` is set to false; The "header2" header is not present and the header matcher rule for "header2" will be ignored so it will not match. * The header match rule specified header "header3" to a string regex match ``^$`` which means an empty string, and :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>` is set to true; The "header3" header is not present. The match rule will treat the "header3" header as an empty header so it will match. * The header match rule specified header "header4" to a string regex match ``^$`` which means an empty string, and :ref:`treat_missing_header_as_empty <envoy_v3_api_field_config.route.v3.HeaderMatcher.treat_missing_header_as_empty>` is set to false; The "header4" header is not present. The match rule for "header4" will be ignored so it will not match.
bool treat_missing_header_as_empty = 14;
- Returns:
- The treatMissingHeaderAsEmpty.
-
getHeaderMatchSpecifierCase
HeaderMatcher.HeaderMatchSpecifierCase getHeaderMatchSpecifierCase()
-