Package io.envoyproxy.envoy.api.v2.route

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
    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.
    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.
    String
    getRegexMatch()
    Deprecated.
    envoy.api.v2.route.HeaderMatcher.regex_match is deprecated.
    com.google.protobuf.ByteString
    getRegexMatchBytes()
    Deprecated.
    envoy.api.v2.route.HeaderMatcher.regex_match is deprecated.
    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
    hasExactMatch()
    If specified, header match will be performed based on the value of the header.
    boolean
    hasPrefixMatch()
    If specified, header match will be performed based on the prefix of the header value.
    boolean
    hasPresentMatch()
    If specified, header match will be performed based on whether the header is in the request.
    boolean
    hasRangeMatch()
    If specified, header match will be performed based on range.
    boolean
    hasRegexMatch()
    Deprecated.
    envoy.api.v2.route.HeaderMatcher.regex_match is deprecated.
    boolean
    hasSafeRegexMatch()
    If specified, this regex string is a regular expression rule which implies the entire request header value must match the regex.
    boolean
    hasSuffixMatch()
    If specified, header match will be performed based on the suffix of the header value.

    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

      boolean hasExactMatch()
       If specified, header match will be performed based on the value of the header.
      string exact_match = 4;
      Returns:
      Whether the exactMatch field is set.

    • getExactMatch

      String getExactMatch()
       If specified, header match will be performed based on the value of the header.
      string exact_match = 4;
      Returns:
      The exactMatch.

    • getExactMatchBytes

      com.google.protobuf.ByteString getExactMatchBytes()
       If specified, header match will be performed based on the value of the header.
      string exact_match = 4;
      Returns:
      The bytes for exactMatch.

    • hasRegexMatch

      @Deprecated boolean hasRegexMatch()
      Deprecated.
      envoy.api.v2.route.HeaderMatcher.regex_match is deprecated. See envoy/api/v2/route/route_components.proto;l=1542
       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 <https://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*

 .. attention::
   This field has been deprecated in favor of `safe_regex_match` as it is not safe for use
   with untrusted input in all cases.
      string regex_match = 5 [deprecated = true, (.validate.rules) = { ... }
      Returns:
      Whether the regexMatch field is set.

    • getRegexMatch

      @Deprecated String getRegexMatch()
      Deprecated.
      envoy.api.v2.route.HeaderMatcher.regex_match is deprecated. See envoy/api/v2/route/route_components.proto;l=1542
       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 <https://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*

 .. attention::
   This field has been deprecated in favor of `safe_regex_match` as it is not safe for use
   with untrusted input in all cases.
      string regex_match = 5 [deprecated = true, (.validate.rules) = { ... }
      Returns:
      The regexMatch.

    • getRegexMatchBytes

      @Deprecated com.google.protobuf.ByteString getRegexMatchBytes()
      Deprecated.
      envoy.api.v2.route.HeaderMatcher.regex_match is deprecated. See envoy/api/v2/route/route_components.proto;l=1542
       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 <https://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*

 .. attention::
   This field has been deprecated in favor of `safe_regex_match` as it is not safe for use
   with untrusted input in all cases.
      string regex_match = 5 [deprecated = true, (.validate.rules) = { ... }
      Returns:
      The bytes for regexMatch.

    • 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.RegexMatcher safe_regex_match = 11;
      Returns:
      Whether the safeRegexMatch field is set.

    • 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.RegexMatcher safe_regex_match = 11;
      Returns:
      The safeRegexMatch.

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

    • hasPresentMatch

      boolean hasPresentMatch()
       If specified, header match will be performed based on whether the header is in the
 request.
      bool present_match = 7;
      Returns:
      Whether the presentMatch field is set.

    • getPresentMatch

      boolean getPresentMatch()
       If specified, header match will be performed based on whether the header is in the
 request.
      bool present_match = 7;
      Returns:
      The presentMatch.

    • hasPrefixMatch

      boolean hasPrefixMatch()
       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) = { ... }
      Returns:
      Whether the prefixMatch field is set.

    • 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) = { ... }
      Returns:
      The prefixMatch.

    • 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) = { ... }
      Returns:
      The bytes for prefixMatch.

    • hasSuffixMatch

      boolean hasSuffixMatch()
       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) = { ... }
      Returns:
      Whether the suffixMatch field is set.

    • 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) = { ... }
      Returns:
      The suffixMatch.

    • 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) = { ... }
      Returns:
      The bytes for suffixMatch.

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

    • getHeaderMatchSpecifierCase

      HeaderMatcher.HeaderMatchSpecifierCase getHeaderMatchSpecifierCase()