package envoy.extensions.filters.http.header_to_metadata.v3

repeated Config.Rule request_rules = 1
The list of rules to apply to requests.
repeated Config.Rule response_rules = 2
The list of rules to apply to responses.

[#next-free-field: 7]

Used in: Rule

string metadata_namespace = 1
The namespace — if this is empty, the filter's namespace will be used.
string key = 2
The key to use within the namespace.
string value = 3
The value to pair with the given key. When used for a :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>` case, if value is non-empty it'll be used instead of the header value. If both are empty, no metadata is added. When used for a :ref:`on_header_missing <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_missing>` case, a non-empty value must be provided otherwise no metadata is added.
optional type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 6
If present, the header's value will be matched and substituted with this. If there is no match or substitution, the header value is used as-is. This is only used for :ref:`on_header_present <envoy_v3_api_field_extensions.filters.http.header_to_metadata.v3.Config.Rule.on_header_present>`. Note: if the ``value`` field is non-empty this field should be empty.
ValueType type = 4
The value's type — defaults to string.
ValueEncode encode = 5
How is the value encoded, default is NONE (not encoded). The value will be decoded accordingly before storing to metadata.

A Rule defines what metadata to apply when a header is present or missing. [#next-free-field: 6]

Used in: Config

string header = 1
Specifies that a match will be performed on the value of a header or a cookie. The header to be extracted.
string cookie = 5
The cookie to be extracted.
optional KeyValuePair on_header_present = 2
If the header or cookie is present, apply this metadata KeyValuePair. If the value in the KeyValuePair is non-empty, it'll be used instead of the header or cookie value.
optional KeyValuePair on_header_missing = 3
If the header or cookie is not present, apply this metadata KeyValuePair. The value in the KeyValuePair must be set, since it'll be used in lieu of the missing header or cookie value.
bool remove = 4
Whether or not to remove the header after a rule is applied. This prevents headers from leaking. This field is not supported in case of a cookie.

ValueEncode defines the encoding algorithm.

NONE = 0
The value is not encoded.
BASE64 = 1
The value is encoded in `Base64 <https://tools.ietf.org/html/rfc4648#section-4>`_. Note: this is mostly used for STRING and PROTOBUF_VALUE to escape the non-ASCII characters in the header.

STRING = 0
NUMBER = 1
PROTOBUF_VALUE = 2
The value is a serialized `protobuf.Value <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto#L62>`_.

message Config