Metadata

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

MetadataKey provides a general interface using key and path to retrieve value from .

For example, for the following Metadata:

The following MetadataKey will retrieve a string value “bar” from the Metadata.

key

(string, REQUIRED) The key name of Metadata to retrieve the Struct from the metadata. Typically, it represents a builtin subsystem or custom extension.

path

(repeated , REQUIRED) The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. for a struct or [prop, foo] for a string in the example, which depends on the particular scenario.

Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.

type.metadata.v3.MetadataKey.PathSegment

Specifies the segment in a path to retrieve value from Metadata. Currently it is only supported to specify the key, i.e. field name, as one segment of a path.

key

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

[type.metadata.v3.MetadataKind proto]

Describes what kind of metadata.

request

() Request kind of metadata.

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

route

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

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

cluster

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