Set-Filter-State filter state value (proto)

extensions.filters.common.set_filter_state.v3.FilterStateValue

[extensions.filters.common.set_filter_state.v3.FilterStateValue proto]

A filter state key and value pair.

{
  "object_key": ...,
  "factory_key": ...,
  "format_string": {...},
  "read_only": ...,
  "shared_with_upstream": ...,
  "skip_if_empty": ...
}
object_key

(string, REQUIRED) Filter state object key. The key is used to lookup the object factory, unless factory_key is set. See the well-known filter state keys for a list of valid object keys.

factory_key

(string) Optional filter object factory lookup key. See the well-known filter state keys for a list of valid factory keys.

format_string

(config.core.v3.SubstitutionFormatString, REQUIRED) Uses the format string to instantiate the filter state object value.

read_only

(bool) If marked as read-only, the filter state key value is locked, and cannot be overridden by any filter, including this filter.

shared_with_upstream

(extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstream) Configures the object to be shared with the upstream internal connections. See internal upstream transport for more details on the filter state sharing with the internal connections.

skip_if_empty

(bool) Skip the update if the value evaluates to an empty string. This option can be used to supply multiple alternatives for the same filter state object key.

Enum extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstream

[extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstream proto]

NONE

(DEFAULT) ⁣Object is not shared with the upstream internal connections.

ONCE

⁣Object is shared with the upstream internal connection.

TRANSITIVE

⁣Object is shared with the upstream internal connection and any internal connection upstream from it.