Set-Metadata Filter (proto)

This extension has the qualified name envoy.filters.http.set_metadata

Note

This extension is intended to be robust against both untrusted downstream and upstream traffic.

Tip

This extension extends and can be used with the following extension category:

This extension must be configured with one of the following type URLs:

This filters adds or updates dynamic metadata with static data.

extensions.filters.http.set_metadata.v3.Metadata

{
  "metadata_namespace": ...,
  "allow_overwrite": ...,
  "value": {...},
  "typed_value": {...}
}

allow_overwrite: (bool) Allow the filter to overwrite or merge with an existing value in the namespace.

value: (Struct) The value to place at the namespace. If allow_overwrite, this will overwrite or merge with any existing values in that namespace. See the filter documentation for more information on how this value is merged with potentially existing ones if allow_overwrite is configured. Only one of value and typed_value may be set.

typed_value: (Any) The value to place at the namespace. If allow_overwrite, this will overwrite any existing values in that namespace. Only one of value and typed_value may be set.

{
  "metadata_namespace": ...,
  "value": {...},
  "metadata": []
}

metadata_namespace: (string) The metadata namespace. This field is deprecated; please use metadata as replacement.

value: (Struct) The untyped value to update the dynamic metadata namespace with. See the filter documentation for more information on how this value is merged with potentially existing ones. This field is deprecated; please use metadata as replacement.

metadata: (repeated extensions.filters.http.set_metadata.v3.Metadata) Defines changes to be made to dynamic metadata.