Struct matcher

type.matcher.v3.StructMatcher

[type.matcher.v3.StructMatcher proto]

StructMatcher provides a general interface to check if a given value is matched in google.protobuf.Struct. It uses path to retrieve the value from the struct and then check if it’s matched to the specified value.

For example, for the following Struct:

  1. fields:
  2.   a:
  3.     struct_value:
  4.       fields:
  5.         b:
  6.           struct_value:
  7.             fields:
  8.               c:
  9.                 string_value: pro
  10.         t:
  11.           list_value:
  12.             values:
  13.               - string_value: m
  14.               - string_value: n

The following MetadataMatcher is matched as the path [a, b, c] will retrieve a string value “pro” from the Metadata which is matched to the specified prefix match.

  1. path:
  2. - key: a
  3. - key: b
  4. - key: c
  5. value:
  6.   string_match:
  7.     prefix: pr

The following StructMatcher is matched as the code will match one of the string values in the list at the path [a, t].

  1. path:
  2. - key: a
  3. - key: t
  4. value:
  5.   list_match:
  6.     one_of:
  7.       string_match:
  8.         exact: m

An example use of StructMatcher is to match metadata in envoy.v*.core.Node.

  1. {
  2.   "path": [],
  3.   "value": "{...}"
  4. }

path

(type.matcher.v3.StructMatcher.PathSegment, REQUIRED) The path to retrieve the Value from the Struct.

value

(type.matcher.v3.ValueMatcher, REQUIRED) The StructMatcher is matched if the value retrieved by path is matched to this value.

type.matcher.v3.StructMatcher.PathSegment

[type.matcher.v3.StructMatcher.PathSegment proto]

Specifies the segment in a path to retrieve value from Struct.

  1. {
  2.   "key": "..."
  3. }

key

(string, REQUIRED) If specified, use the key to retrieve the value in a Struct.