Class HeaderMatcher
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.route.v3.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.GeneratedMessage
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", "string_match": { "exact": "POST" } } .. attention:: In the absence of any header match specifier, match will default to :ref:`present_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`. i.e, a request that has the :ref:`name <envoy_v3_api_field_config.route.v3.HeaderMatcher.name>` header will match, regardless of the header's value. [#next-major-version: HeaderMatcher should be refactored to use StringMatcher.] [#next-free-field: 15]Protobuf type
envoy.config.route.v3.HeaderMatcher
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
..static enum
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
private static final HeaderMatcher
static final int
private Object
private int
static final int
private boolean
private byte
private Object
static final int
private static final com.google.protobuf.Parser
<HeaderMatcher> static final int
static final int
static final int
static final int
private static final long
static final int
static final int
static final int
private boolean
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
HeaderMatcher
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.static HeaderMatcher
static final com.google.protobuf.Descriptors.Descriptor
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.boolean
If specified, the match result will be inverted before checking.getName()
Specifies the name of the header in the request.com.google.protobuf.ByteString
Specifies the name of the header in the request.com.google.protobuf.Parser
<HeaderMatcher> Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.boolean
If specified as true, header match will be performed based on whether the header is in the request.If specified, header match will be performed based on range.If specified, header match will be performed based on range.Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated.Deprecated.int
If specified, header match will be performed based on the string match of the header value.If specified, header match will be performed based on the string match of the header value.Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.boolean
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.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated.int
hashCode()
boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated.boolean
If specified as true, header match will be performed based on whether the header is in the request.boolean
If specified, header match will be performed based on range.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated.boolean
If specified, header match will be performed based on the string match of the header value.boolean
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static HeaderMatcher.Builder
static HeaderMatcher.Builder
newBuilder
(HeaderMatcher prototype) protected HeaderMatcher.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static HeaderMatcher
parseDelimitedFrom
(InputStream input) static HeaderMatcher
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderMatcher
parseFrom
(byte[] data) static HeaderMatcher
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderMatcher
parseFrom
(com.google.protobuf.ByteString data) static HeaderMatcher
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderMatcher
parseFrom
(com.google.protobuf.CodedInputStream input) static HeaderMatcher
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderMatcher
parseFrom
(InputStream input) static HeaderMatcher
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static HeaderMatcher
parseFrom
(ByteBuffer data) static HeaderMatcher
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<HeaderMatcher> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
headerMatchSpecifierCase_
private int headerMatchSpecifierCase_ -
headerMatchSpecifier_
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
EXACT_MATCH_FIELD_NUMBER
public static final int EXACT_MATCH_FIELD_NUMBER- See Also:
-
SAFE_REGEX_MATCH_FIELD_NUMBER
public static final int SAFE_REGEX_MATCH_FIELD_NUMBER- See Also:
-
RANGE_MATCH_FIELD_NUMBER
public static final int RANGE_MATCH_FIELD_NUMBER- See Also:
-
PRESENT_MATCH_FIELD_NUMBER
public static final int PRESENT_MATCH_FIELD_NUMBER- See Also:
-
PREFIX_MATCH_FIELD_NUMBER
public static final int PREFIX_MATCH_FIELD_NUMBER- See Also:
-
SUFFIX_MATCH_FIELD_NUMBER
public static final int SUFFIX_MATCH_FIELD_NUMBER- See Also:
-
CONTAINS_MATCH_FIELD_NUMBER
public static final int CONTAINS_MATCH_FIELD_NUMBER- See Also:
-
STRING_MATCH_FIELD_NUMBER
public static final int STRING_MATCH_FIELD_NUMBER- See Also:
-
INVERT_MATCH_FIELD_NUMBER
public static final int INVERT_MATCH_FIELD_NUMBER- See Also:
-
invertMatch_
private boolean invertMatch_ -
TREAT_MISSING_HEADER_AS_EMPTY_FIELD_NUMBER
public static final int TREAT_MISSING_HEADER_AS_EMPTY_FIELD_NUMBER- See Also:
-
treatMissingHeaderAsEmpty_
private boolean treatMissingHeaderAsEmpty_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
HeaderMatcher
private HeaderMatcher(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
HeaderMatcher
private HeaderMatcher()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getHeaderMatchSpecifierCase
- Specified by:
getHeaderMatchSpecifierCase
in interfaceHeaderMatcherOrBuilder
-
getName
Specifies the name of the header in the request.
string name = 1 [(.validate.rules) = { ... }
- Specified by:
getName
in interfaceHeaderMatcherOrBuilder
- 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 interfaceHeaderMatcherOrBuilder
- Returns:
- The bytes for name.
-
hasExactMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2241If 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"];
- Specified by:
hasExactMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the exactMatch field is set.
-
getExactMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2241If 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"];
- Specified by:
getExactMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The exactMatch.
-
getExactMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.exact_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2241If 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"];
- Specified by:
getExactMatchBytes
in interfaceHeaderMatcherOrBuilder
- Returns:
- The bytes for exactMatch.
-
hasSafeRegexMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2248If 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"];
- Specified by:
hasSafeRegexMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the safeRegexMatch field is set.
-
getSafeRegexMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.safe_regex_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2248If 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"];
- Specified by:
getSafeRegexMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The safeRegexMatch.
-
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"];
- Specified by:
getSafeRegexMatchOrBuilder
in interfaceHeaderMatcherOrBuilder
-
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.v3.Int64Range range_match = 6;
- Specified by:
hasRangeMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the rangeMatch field is set.
-
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;
- Specified by:
getRangeMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The rangeMatch.
-
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;
- Specified by:
getRangeMatchOrBuilder
in interfaceHeaderMatcherOrBuilder
-
hasPresentMatch
public 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;
- Specified by:
hasPresentMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the presentMatch field is set.
-
getPresentMatch
public 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;
- Specified by:
getPresentMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The presentMatch.
-
hasPrefixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2275If 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) = { ... }
- Specified by:
hasPrefixMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the prefixMatch field is set.
-
getPrefixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2275If 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) = { ... }
- Specified by:
getPrefixMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The prefixMatch.
-
getPrefixMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.prefix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2275If 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) = { ... }
- Specified by:
getPrefixMatchBytes
in interfaceHeaderMatcherOrBuilder
- Returns:
- The bytes for prefixMatch.
-
hasSuffixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2288If 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) = { ... }
- Specified by:
hasSuffixMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the suffixMatch field is set.
-
getSuffixMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2288If 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) = { ... }
- Specified by:
getSuffixMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The suffixMatch.
-
getSuffixMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.suffix_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2288If 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) = { ... }
- Specified by:
getSuffixMatchBytes
in interfaceHeaderMatcherOrBuilder
- Returns:
- The bytes for suffixMatch.
-
hasContainsMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2302If 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) = { ... }
- Specified by:
hasContainsMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the containsMatch field is set.
-
getContainsMatch
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2302If 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) = { ... }
- Specified by:
getContainsMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The containsMatch.
-
getContainsMatchBytes
Deprecated.envoy.config.route.v3.HeaderMatcher.contains_match is deprecated. See envoy/config/route/v3/route_components.proto;l=2302If 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) = { ... }
- Specified by:
getContainsMatchBytes
in interfaceHeaderMatcherOrBuilder
- Returns:
- The bytes for containsMatch.
-
hasStringMatch
public 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;
- Specified by:
hasStringMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- Whether the stringMatch field is set.
-
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;
- Specified by:
getStringMatch
in interfaceHeaderMatcherOrBuilder
- Returns:
- The stringMatch.
-
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;
- Specified by:
getStringMatchOrBuilder
in interfaceHeaderMatcherOrBuilder
-
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 interfaceHeaderMatcherOrBuilder
- Returns:
- The invertMatch.
-
getTreatMissingHeaderAsEmpty
public boolean getTreatMissingHeaderAsEmpty()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;
- Specified by:
getTreatMissingHeaderAsEmpty
in interfaceHeaderMatcherOrBuilder
- Returns:
- The treatMissingHeaderAsEmpty.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static HeaderMatcher parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static HeaderMatcher parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static HeaderMatcher parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static HeaderMatcher parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected HeaderMatcher.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-