syntax = "proto3";

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

import "envoy/config/core/v3/substitution_format_string.proto";

import "envoy/annotations/deprecation.proto";
import "udpa/annotations/status.proto";
import "validate/validate.proto";

option java_package = "io.envoyproxy.envoy.extensions.filters.common.set_filter_state.v3";
option java_outer_classname = "ValueProto";
option java_multiple_files = true;
option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/common/set_filter_state/v3;set_filter_statev3";
option (udpa.annotations.file_status).package_version_status = ACTIVE;

// [#protodoc-title: Set-Filter-State filter state value]

// A filter state key and value pair.
// [#next-free-field: 7]
message FilterStateValue {
  enum SharedWithUpstream {
    // Object is not shared with the upstream internal connections.
    NONE = 0;

    // Object is shared with the upstream internal connection.
    ONCE = 1;

    // Object is shared with the upstream internal connection and any internal connection upstream from it.
    TRANSITIVE = 2;
  }

  oneof key {
    option (validate.required) = true;

    // The name under which the filter state object will be stored and can be retrieved.
    //
    // When using :ref:`well-known filter state keys <well_known_filter_state>` (e.g.,
    // ``envoy.network.upstream_server_name``, ``envoy.tcp_proxy.cluster``), the object key serves
    // dual purpose where it identifies both where the data is stored and which factory creates the
    // object. In this case, :ref:`factory_key
    // <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>`
    // is not needed.
    //
    // When using a custom key name which is not from the well-known list, you must also specify
    // :ref:`factory_key
    // <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>`
    // to indicate which factory should create the object from your value.
    //
    // Example using a well-known key where ``factory_key`` is not needed:
    //
    // .. code-block:: yaml
    //
    //    object_key: envoy.tcp_proxy.cluster
    //    format_string:
    //      text_format_source:
    //        inline_string: "my-cluster"
    //
    // Example using a custom key which requires a ``factory_key``:
    //
    // .. code-block:: yaml
    //
    //    object_key: my.custom.key
    //    factory_key: envoy.string
    //    format_string:
    //      text_format_source:
    //        inline_string: "my-value"
    //
    string object_key = 1 [(validate.rules).string = {min_len: 1}];
  }

  // Specifies which registered factory should be used to create the filter state object from the
  // provided value. This field is required when :ref:`object_key
  // <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.object_key>`
  // is a custom name not found in the :ref:`well-known filter state keys <well_known_filter_state>`.
  //
  // Each well-known key has a factory registered with the same name (e.g., the key
  // ``envoy.tcp_proxy.cluster`` has a factory also named ``envoy.tcp_proxy.cluster``). For custom keys,
  // use one of the following generic factories:
  //
  // * ``envoy.string``: Creates a generic string object. Use this for arbitrary string values that
  //   will be accessed via ``StringAccessor``.
  //
  // If not specified, defaults to the value of ``object_key``.
  string factory_key = 6;

  oneof value {
    option (validate.required) = true;

    // Uses the :ref:`format string <config_access_log_format_strings>` to
    // instantiate the filter state object value.
    config.core.v3.SubstitutionFormatString format_string = 2;
  }

  // This field is deprecated and its value has no effect.
  bool read_only = 3 [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];

  // 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.
  SharedWithUpstream shared_with_upstream = 4;

  // 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.
  bool skip_if_empty = 5;
}
