Metadata (proto)

type.metadata.v3.MetadataKey

MetadataKey provides a way to retrieve values from Metadata using a key and a path.

For example, consider the following Metadata:

filter_metadata:
  envoy.xxx:
    prop:
      foo: bar
      xyz:
        hello: envoy

The following MetadataKey would retrieve the string value “bar” from the Metadata:

key: envoy.xxx
path:
- key: prop
- key: foo

{
  "key": ...,
  "path": []
}

key: (string, REQUIRED) The key name of the Metadata from which to retrieve the Struct. This typically represents a builtin subsystem or custom extension.

path: (repeated type.metadata.v3.MetadataKey.PathSegment, REQUIRED) The path used to retrieve a specific Value from the Struct. This can be either a prefix or a full path, depending on the use case. For example, [prop, xyz] would retrieve a struct or [prop, foo] would retrieve a string in the example above.

Note

Since only key-type segments are supported, a path cannot specify a list unless the list is the last segment.

Specifies a segment in a path for retrieving values from Metadata. Currently, only key-based segments (field names) are supported.

{
  "key": ...
}

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

Describes different types of metadata sources.

{
  "request": {...},
  "route": {...},
  "cluster": {...},
  "host": {...}
}

request

Precisely one of request, route, cluster, host must be set.

route

Precisely one of request, route, cluster, host must be set.

cluster

Precisely one of request, route, cluster, host must be set.

host

(type.metadata.v3.MetadataKind.Host) Host kind of metadata.

Precisely one of request, route, cluster, host must be set.

Represents dynamic metadata associated with the request.

Represents metadata from the route.

Represents metadata from the upstream cluster.

Represents metadata from the upstream host.