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

Class HeaderMatcher

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderMatcherOrBuilder, Serializable
    public final class HeaderMatcher
extends com.google.protobuf.GeneratedMessageV3
implements HeaderMatcherOrBuilder
     .. attention::
   Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host*
   header. Thus, if attempting to match on *Host*, match on *:authority* instead.
 .. attention::
   To route on HTTP method, use the special HTTP/2 *:method* header. This works for both
   HTTP/1 and HTTP/2 as Envoy normalizes headers. E.g.,
   .. code-block:: json
     {
       "name": ":method",
       "exact_match": "POST"
     }
 .. attention::
   In the absence of any header match specifier, match will default to :ref:`present_match
   <envoy_api_field_route.HeaderMatcher.present_match>`. i.e, a request that has the :ref:`name
   <envoy_api_field_route.HeaderMatcher.name>` header will match, regardless of the header's
   value.
  [#next-major-version: HeaderMatcher should be refactored to use StringMatcher.]
 [#next-free-field: 12]
    Protobuf type envoy.api.v2.route.HeaderMatcher
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HeaderMatcher.Builder
      .. attention:: Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host* header.
      static class  HeaderMatcher.HeaderMatchSpecifierCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Specifies the name of the header in the request.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getName in interface HeaderMatcherOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Specifies the name of the header in the request.
        string name = 1 [(.validate.rules) = { ... }
        Specified by:
        getNameBytes in interface HeaderMatcherOrBuilder
        Returns:
        The bytes for name.

      • hasExactMatch

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

      • getExactMatch

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

      • getExactMatchBytes

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

      • hasRegexMatch

        @Deprecated
public boolean hasRegexMatch()
        Deprecated.
        envoy.api.v2.route.HeaderMatcher.regex_match is deprecated. See envoy/api/v2/route/route_components.proto;l=1541
         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) = { ... }
        Specified by:
        hasRegexMatch in interface HeaderMatcherOrBuilder
        Returns:
        Whether the regexMatch field is set.

      • getRegexMatch

        @Deprecated
public String getRegexMatch()
        Deprecated.
        envoy.api.v2.route.HeaderMatcher.regex_match is deprecated. See envoy/api/v2/route/route_components.proto;l=1541
         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) = { ... }
        Specified by:
        getRegexMatch in interface HeaderMatcherOrBuilder
        Returns:
        The regexMatch.

      • getRegexMatchBytes

        @Deprecated
public com.google.protobuf.ByteString getRegexMatchBytes()
        Deprecated.
        envoy.api.v2.route.HeaderMatcher.regex_match is deprecated. See envoy/api/v2/route/route_components.proto;l=1541
         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) = { ... }
        Specified by:
        getRegexMatchBytes in interface HeaderMatcherOrBuilder
        Returns:
        The bytes for regexMatch.

      • hasSafeRegexMatch

        public 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;
        Specified by:
        hasSafeRegexMatch in interface HeaderMatcherOrBuilder
        Returns:
        Whether the safeRegexMatch field is set.

      • getSafeRegexMatch

        public 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;
        Specified by:
        getSafeRegexMatch in interface HeaderMatcherOrBuilder
        Returns:
        The safeRegexMatch.

      • getSafeRegexMatchOrBuilder

        public 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;
        Specified by:
        getSafeRegexMatchOrBuilder in interface HeaderMatcherOrBuilder

      • hasRangeMatch

        public 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;
        Specified by:
        hasRangeMatch in interface HeaderMatcherOrBuilder
        Returns:
        Whether the rangeMatch field is set.

      • getRangeMatch

        public 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;
        Specified by:
        getRangeMatch in interface HeaderMatcherOrBuilder
        Returns:
        The rangeMatch.

      • getRangeMatchOrBuilder

        public 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;
        Specified by:
        getRangeMatchOrBuilder in interface HeaderMatcherOrBuilder

      • hasPresentMatch

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

      • getPresentMatch

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

      • hasPrefixMatch

        public 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) = { ... }
        Specified by:
        hasPrefixMatch in interface HeaderMatcherOrBuilder
        Returns:
        Whether the prefixMatch field is set.

      • getPrefixMatch

        public 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) = { ... }
        Specified by:
        getPrefixMatch in interface HeaderMatcherOrBuilder
        Returns:
        The prefixMatch.

      • getPrefixMatchBytes

        public 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) = { ... }
        Specified by:
        getPrefixMatchBytes in interface HeaderMatcherOrBuilder
        Returns:
        The bytes for prefixMatch.

      • hasSuffixMatch

        public 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) = { ... }
        Specified by:
        hasSuffixMatch in interface HeaderMatcherOrBuilder
        Returns:
        Whether the suffixMatch field is set.

      • getSuffixMatch

        public 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) = { ... }
        Specified by:
        getSuffixMatch in interface HeaderMatcherOrBuilder
        Returns:
        The suffixMatch.

      • getSuffixMatchBytes

        public 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) = { ... }
        Specified by:
        getSuffixMatchBytes in interface HeaderMatcherOrBuilder
        Returns:
        The bytes for suffixMatch.

      • getInvertMatch

        public 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;
        Specified by:
        getInvertMatch in interface HeaderMatcherOrBuilder
        Returns:
        The invertMatch.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static HeaderMatcher parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderMatcher parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderMatcher parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderMatcher parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderMatcher parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderMatcher parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HeaderMatcher parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public HeaderMatcher.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public HeaderMatcher.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected HeaderMatcher.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static HeaderMatcher getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<HeaderMatcher> parser()

      • getParserForType

        public com.google.protobuf.Parser<HeaderMatcher> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public HeaderMatcher getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder