io.envoyproxy.envoy.config.route.v3.HeaderMatcherOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
There is a newer version: 1.0.47
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/config/route/v3/route_components.proto

package io.envoyproxy.envoy.config.route.v3;

public interface HeaderMatcherOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.config.route.v3.HeaderMatcher)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Specifies the name of the header in the request.
   * 
   *
   * string name = 1 [(.validate.rules) = { ... }
   */
  java.lang.String getName();
  /**
   *    * Specifies the name of the header in the request.
   * 
   *
   * string name = 1 [(.validate.rules) = { ... }
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * If specified, header match will be performed based on the value of the header.
   * 
   *
   * string exact_match = 4;
   */
  java.lang.String getExactMatch();
  /**
   *    * If specified, header match will be performed based on the value of the header.
   * 
   *
   * string exact_match = 4;
   */
  com.google.protobuf.ByteString
      getExactMatchBytes();

  /**
   *    * 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;
   */
  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;
   */
  io.envoyproxy.envoy.type.matcher.v3.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;
   */
  io.envoyproxy.envoy.type.matcher.v3.RegexMatcherOrBuilder getSafeRegexMatchOrBuilder();

  /**
   *    * 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;
   */
  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;
   */
  io.envoyproxy.envoy.type.v3.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;
   */
  io.envoyproxy.envoy.type.v3.Int64RangeOrBuilder getRangeMatchOrBuilder();

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

  /**
   *    * 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) = { ... }
   */
  java.lang.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) = { ... }
   */
  com.google.protobuf.ByteString
      getPrefixMatchBytes();

  /**
   *    * 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) = { ... }
   */
  java.lang.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) = { ... }
   */
  com.google.protobuf.ByteString
      getSuffixMatchBytes();

  /**
   *    * 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;
   */
  boolean getInvertMatch();

  public io.envoyproxy.envoy.config.route.v3.HeaderMatcher.HeaderMatchSpecifierCase getHeaderMatchSpecifierCase();
}