package envoy.config.common.matcher.v3

Get desktop application:
View/edit binary Protocol Buffers messages

HTTP generic body match configuration. List of text strings and hex strings to be located in HTTP body. All specified strings must be found in the HTTP body for positive match. The search may be limited to specified number of bytes from the body start. .. attention:: Searching for patterns in HTTP body is potentially cpu intensive. For each specified pattern, http body is scanned byte by byte to find a match. If multiple patterns are specified, the process is repeated for each pattern. If location of a pattern is known, ``bytes_limit`` should be specified to scan only part of the http body.

Used in: MatchPredicate

• uint32 bytes_limit = 1

  Limits search to specified number of bytes - default zero (no limit - match entire captured buffer).

• repeated HttpGenericBodyMatch.GenericTextMatch patterns = 2

  List of patterns to match.

Used in: HttpGenericBodyMatch

• oneof rule

  • string string_match = 1

    Text string to be located in HTTP body.

  • bytes binary_match = 2

    Sequence of bytes to be located in HTTP body.

HTTP headers match configuration.

Used in: MatchPredicate

• repeated route.v3.HeaderMatcher headers = 1

  HTTP headers to match.

Match configuration. This is a recursive structure which allows complex nested match configurations to be built using various logical operators. [#next-free-field: 11]

Used in: MatchPredicate.MatchSet, tap.v3.TapConfig

• oneof rule

  • MatchPredicate.MatchSet or_match = 1

    A set that describes a logical OR. If any member of the set matches, the match configuration matches.

  • MatchPredicate.MatchSet and_match = 2

    A set that describes a logical AND. If all members of the set match, the match configuration matches.

  • MatchPredicate not_match = 3

    A negation match. The match configuration will match if the negated match condition matches.

  • bool any_match = 4

    The match configuration will always match.

  • HttpHeadersMatch http_request_headers_match = 5

    HTTP request headers match configuration.

  • HttpHeadersMatch http_request_trailers_match = 6

    HTTP request trailers match configuration.

  • HttpHeadersMatch http_response_headers_match = 7

    HTTP response headers match configuration.

  • HttpHeadersMatch http_response_trailers_match = 8

    HTTP response trailers match configuration.

  • HttpGenericBodyMatch http_request_generic_body_match = 9

    HTTP request generic body match configuration.

  • HttpGenericBodyMatch http_response_generic_body_match = 10

    HTTP response generic body match configuration.

A set of match configurations used for logical operations.

Used in: MatchPredicate

• repeated MatchPredicate rules = 1

  The list of rules that make up the set.

A matcher, which may traverse a matching tree in order to result in a match action. During matching, the tree will be traversed until a match is found, or if no match is found the action specified by the most specific on_no_match will be evaluated. As an on_no_match might result in another matching tree being evaluated, this process might repeat several times until the final OnMatch (or no match) is decided. .. note:: Please use the syntactically equivalent :ref:`matching API <envoy_v3_api_msg_.xds.type.matcher.v3.Matcher>`

Used in: Matcher.OnMatch, extensions.common.matching.v3.ExtensionWithMatcher

• oneof matcher_type

  • Matcher.MatcherList matcher_list = 1

    A linear list of matchers to evaluate.

  • Matcher.MatcherTree matcher_tree = 2

    A match tree to evaluate.

• optional Matcher.OnMatch on_no_match = 3

  Optional OnMatch to use if the matcher failed. If specified, the OnMatch is used, and the matcher is considered to have matched. If not specified, the matcher is considered not to have matched.

A linear list of field matchers. The field matchers are evaluated in order, and the first match wins.

Used in: Matcher

• repeated MatcherList.FieldMatcher matchers = 1

  A list of matchers. First match wins.

An individual matcher.

Used in: MatcherList

• optional Predicate predicate = 1

  Determines if the match succeeds.

• optional OnMatch on_match = 2

  What to do if the match succeeds.

Predicate to determine if a match is successful.

Used in: FieldMatcher, Predicate.PredicateList

• oneof match_type

  • Predicate.SinglePredicate single_predicate = 1

    A single predicate to evaluate.

  • Predicate.PredicateList or_matcher = 2

    A list of predicates to be OR-ed together.

  • Predicate.PredicateList and_matcher = 3

    A list of predicates to be AND-ed together.

  • Predicate not_matcher = 4

    The invert of a predicate

A list of two or more matchers. Used to allow using a list within a oneof.

Used in: Predicate

• repeated Predicate predicate = 1

Predicate for a single input field.

Used in: Predicate

• optional core.v3.TypedExtensionConfig input = 1

  Protocol-specific specification of input field to match on. [#extension-category: envoy.matching.common_inputs]

• oneof matcher

  • type.matcher.v3.StringMatcher value_match = 2

    Built-in string matcher.

  • core.v3.TypedExtensionConfig custom_match = 3

    Extension for custom matching logic. [#extension-category: envoy.matching.input_matchers]

Used in: Matcher

• optional core.v3.TypedExtensionConfig input = 1

  Protocol-specific specification of input field to match on.

• oneof tree_type

  Exact or prefix match maps in which to look up the input value. If the lookup succeeds, the match is considered successful, and the corresponding OnMatch is used.

  • MatcherTree.MatchMap exact_match_map = 2

  • MatcherTree.MatchMap prefix_match_map = 3

    Longest matching prefix wins.

  • core.v3.TypedExtensionConfig custom_match = 4

    Extension for custom matching logic.

A map of configured matchers. Used to allow using a map within a oneof.

Used in: MatcherTree

• map<string, OnMatch> map = 1

What to do if a match is successful.

Used in: Matcher, MatcherList.FieldMatcher, MatcherTree.MatchMap

• oneof on_match

  • Matcher matcher = 1

    Nested matcher to evaluate. If the nested matcher does not match and does not specify on_no_match, then this matcher is considered not to have matched, even if a predicate at this level or above returned true.

  • core.v3.TypedExtensionConfig action = 2

    Protocol-specific action to take.