Package 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 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

        @Deprecated
String getExactMatch()
        Deprecated.
         If 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"];

      • getExactMatchBytes

        @Deprecated
com.google.protobuf.ByteString getExactMatchBytes()
        Deprecated.
         If 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"];

      • hasSafeRegexMatch

        @Deprecated
boolean hasSafeRegexMatch()
        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"];

      • getSafeRegexMatch

        @Deprecated
RegexMatcher getSafeRegexMatch()
        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"];

      • getSafeRegexMatchOrBuilder

        @Deprecated
RegexMatcherOrBuilder 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;

      • 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 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;

      • getPrefixMatch

        @Deprecated
String getPrefixMatch()
        Deprecated.
         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.
 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) = { ... }

      • getPrefixMatchBytes

        @Deprecated
com.google.protobuf.ByteString getPrefixMatchBytes()
        Deprecated.
         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.
 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) = { ... }

      • getSuffixMatch

        @Deprecated
String getSuffixMatch()
        Deprecated.
         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.
 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) = { ... }

      • getSuffixMatchBytes

        @Deprecated
com.google.protobuf.ByteString getSuffixMatchBytes()
        Deprecated.
         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.
 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) = { ... }

      • getContainsMatch

        @Deprecated
String getContainsMatch()
        Deprecated.
         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.
 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) = { ... }

      • getContainsMatchBytes

        @Deprecated
com.google.protobuf.ByteString getContainsMatchBytes()
        Deprecated.
         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.
 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) = { ... }

      • 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;

      • 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;

      • 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;