package envoy.type.metadata.v3

Get desktop application:
View/edit binary Protocol Buffers messages

MetadataKey provides a general interface using ``key`` and ``path`` to retrieve value from :ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`. For example, for the following Metadata: .. code-block:: yaml filter_metadata: envoy.xxx: prop: foo: bar xyz: hello: envoy The following MetadataKey will retrieve a string value "bar" from the Metadata. .. code-block:: yaml key: envoy.xxx path: - key: prop - key: foo

Used in: config.cluster.v3.Cluster.OriginalDstLbConfig, config.route.v3.RateLimit.Action.DynamicMetaData, config.route.v3.RateLimit.Action.MetaData, config.route.v3.RateLimit.Override.DynamicMetadata, tracing.v3.CustomTag.Metadata

• string key = 1

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

• repeated MetadataKey.PathSegment path = 2

  The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` 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.

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.

Used in: MetadataKey

• oneof segment

  • string key = 1

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

Describes what kind of metadata.

Used in: extensions.transport_sockets.internal_upstream.v3.InternalUpstreamTransport.MetadataValueSource, tracing.v3.CustomTag.Metadata

• oneof kind

  • MetadataKind.Request request = 1

    Request kind of metadata.

  • MetadataKind.Route route = 2

    Route kind of metadata.

  • MetadataKind.Cluster cluster = 3

    Cluster kind of metadata.

  • MetadataKind.Host host = 4

    Host kind of metadata.

Represents metadata from :ref:`the upstream cluster<envoy_v3_api_field_config.cluster.v3.Cluster.metadata>`.

Used in: MetadataKind

(message has no fields)

Represents metadata from :ref:`the upstream host<envoy_v3_api_field_config.endpoint.v3.LbEndpoint.metadata>`.

Used in: MetadataKind

(message has no fields)

Represents dynamic metadata associated with the request.

Used in: MetadataKind

(message has no fields)

Represents metadata from :ref:`the route<envoy_v3_api_field_config.route.v3.Route.metadata>`.

Used in: MetadataKind

(message has no fields)