package envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3

Get desktop application:
View/edit binary Protocol Buffers messages

• repeated HeaderToMetadata.Rule request_rules = 1

  The list of rules to apply to requests.

[#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.

• oneof value_type

  • string value = 3

    The value to pair with the given key. When used for on_present case, if value is non-empty it'll be used instead of the header value. If both are empty, the header value is used as-is. When used for on_missing case, a non-empty value must be provided.

  • type.matcher.v3.RegexMatchAndSubstitute regex_value_rewrite = 4

    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 on_present.

• ValueType type = 5

  The value's type — defaults to string.

• ValueEncode encode = 6

  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.

Used in: HeaderToMetadata

• string header = 1

  Specifies that a match will be performed on the value of a header. The header to be extracted.

• optional KeyValuePair on_present = 2

  If the header is present, apply this metadata KeyValuePair. If the value in the KeyValuePair is non-empty, it'll be used instead of the header value.

• optional KeyValuePair on_missing = 3

  If the header 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 value.

• bool remove = 4

  Whether or not to remove the header after a rule is applied. This prevents headers from leaking.

ValueEncode defines the encoding algorithm.

Used in: KeyValuePair

• 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.

Used in: KeyValuePair

• 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>`_.