package envoy.extensions.filters.common.set_filter_state.v3

Get desktop application:
View/edit binary Protocol Buffers messages

A filter state key and value pair. [#next-free-field: 7]

Used in: http.set_filter_state.v3.Config, network.set_filter_state.v3.Config

• oneof key

  • string object_key = 1

    Filter state object key. The key is used to lookup the object factory, unless :ref:`factory_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is set. See :ref:`the well-known filter state keys <well_known_filter_state>` for a list of valid object keys.

• string factory_key = 6

  Optional filter object factory lookup key. See :ref:`the well-known filter state keys <well_known_filter_state>` for a list of valid factory keys.

• oneof value

  • config.core.v3.SubstitutionFormatString format_string = 2

    Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.

• bool read_only = 3

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

• FilterStateValue.SharedWithUpstream shared_with_upstream = 4

  Configures the object to be shared with the upstream internal connections. See :ref:`internal upstream transport <config_internal_upstream_transport>` for more details on the filter state sharing with the internal connections.

• bool skip_if_empty = 5

  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.

Used in: FilterStateValue

• NONE = 0

  Object is not shared with the upstream internal connections.

• ONCE = 1

  Object is shared with the upstream internal connection.

• TRANSITIVE = 2

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