// 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) = { ... }
* @return The name.
*/
java.lang.String getName();
/**
*
* Specifies the name of the header in the request.
*
*
* string name = 1 [(.validate.rules) = { ... }
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* 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"];
* @deprecated envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2234
* @return Whether the exactMatch field is set.
*/
@java.lang.Deprecated boolean hasExactMatch();
/**
*
* 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"];
* @deprecated envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2234
* @return The exactMatch.
*/
@java.lang.Deprecated java.lang.String getExactMatch();
/**
*
* 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"];
* @deprecated envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2234
* @return The bytes for exactMatch.
*/
@java.lang.Deprecated 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.
* 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"];
* @deprecated envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2241
* @return Whether the safeRegexMatch field is set.
*/
@java.lang.Deprecated 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.
* 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"];
* @deprecated envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2241
* @return The safeRegexMatch.
*/
@java.lang.Deprecated 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.
* 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"];
*/
@java.lang.Deprecated 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;
* @return Whether the rangeMatch field is set.
*/
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;
* @return The rangeMatch.
*/
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 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;
* @return Whether the presentMatch field is set.
*/
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;
* @return The presentMatch.
*/
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.
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2268
* @return Whether the prefixMatch field is set.
*/
@java.lang.Deprecated 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.
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2268
* @return The prefixMatch.
*/
@java.lang.Deprecated 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.
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2268
* @return The bytes for prefixMatch.
*/
@java.lang.Deprecated 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.
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2281
* @return Whether the suffixMatch field is set.
*/
@java.lang.Deprecated 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.
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2281
* @return The suffixMatch.
*/
@java.lang.Deprecated 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.
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2281
* @return The bytes for suffixMatch.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getSuffixMatchBytes();
/**
*
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2295
* @return Whether the containsMatch field is set.
*/
@java.lang.Deprecated boolean hasContainsMatch();
/**
*
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2295
* @return The containsMatch.
*/
@java.lang.Deprecated java.lang.String getContainsMatch();
/**
*
* 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) = { ... }
* @deprecated envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.
* See envoy/config/route/v3/route_components.proto;l=2295
* @return The bytes for containsMatch.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getContainsMatchBytes();
/**
*
* If specified, header match will be performed based on the string match of the header value.
*
*
* .envoy.type.matcher.v3.StringMatcher string_match = 13;
* @return Whether the stringMatch field is set.
*/
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;
* @return The stringMatch.
*/
io.envoyproxy.envoy.type.matcher.v3.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;
*/
io.envoyproxy.envoy.type.matcher.v3.StringMatcherOrBuilder getStringMatchOrBuilder();
/**
*
* 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;
* @return The invertMatch.
*/
boolean getInvertMatch();
/**
*
* 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;
* @return The treatMissingHeaderAsEmpty.
*/
boolean getTreatMissingHeaderAsEmpty();
public io.envoyproxy.envoy.config.route.v3.HeaderMatcher.HeaderMatchSpecifierCase getHeaderMatchSpecifierCase();
}
