Package io.envoyproxy.envoy.extensions.filters.common.set_filter_state.v3

Interface FilterStateValueOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FilterStateValue, FilterStateValue.Builder
public interface FilterStateValueOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFactoryKey()
    Specifies which registered factory should be used to create the filter state object from the provided value.
    com.google.protobuf.ByteString
    getFactoryKeyBytes()
    Specifies which registered factory should be used to create the filter state object from the provided value.
    SubstitutionFormatString
    getFormatString()
    Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.
    SubstitutionFormatStringOrBuilder
    getFormatStringOrBuilder()
    Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.
    FilterStateValue.KeyCase
    getKeyCase()
     
    String
    getObjectKey()
    The name under which the filter state object will be stored and can be retrieved.
    com.google.protobuf.ByteString
    getObjectKeyBytes()
    The name under which the filter state object will be stored and can be retrieved.
    boolean
    getReadOnly()
    If marked as read-only, the filter state key value is locked, and cannot be overridden by any filter, including this filter.
    FilterStateValue.SharedWithUpstream
    getSharedWithUpstream()
    Configures the object to be shared with the upstream internal connections.
    int
    getSharedWithUpstreamValue()
    Configures the object to be shared with the upstream internal connections.
    boolean
    getSkipIfEmpty()
    Skip the update if the value evaluates to an empty string.
    FilterStateValue.ValueCase
    getValueCase()
     
    boolean
    hasFormatString()
    Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.
    boolean
    hasObjectKey()
    The name under which the filter state object will be stored and can be retrieved.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasObjectKey

      boolean hasObjectKey()
       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) = { ... }
      Returns:
      Whether the objectKey field is set.

    • getObjectKey

      String getObjectKey()
       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) = { ... }
      Returns:
      The objectKey.

    • getObjectKeyBytes

      com.google.protobuf.ByteString getObjectKeyBytes()
       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) = { ... }
      Returns:
      The bytes for objectKey.

    • getFactoryKey

      String getFactoryKey()
       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;
      Returns:
      The factoryKey.

    • getFactoryKeyBytes

      com.google.protobuf.ByteString getFactoryKeyBytes()
       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;
      Returns:
      The bytes for factoryKey.

    • hasFormatString

      boolean hasFormatString()
       Uses the :ref:`format string <config_access_log_format_strings>` to
 instantiate the filter state object value.
      .envoy.config.core.v3.SubstitutionFormatString format_string = 2;
      Returns:
      Whether the formatString field is set.

    • getFormatString

      SubstitutionFormatString getFormatString()
       Uses the :ref:`format string <config_access_log_format_strings>` to
 instantiate the filter state object value.
      .envoy.config.core.v3.SubstitutionFormatString format_string = 2;
      Returns:
      The formatString.

    • getFormatStringOrBuilder

      SubstitutionFormatStringOrBuilder getFormatStringOrBuilder()
       Uses the :ref:`format string <config_access_log_format_strings>` to
 instantiate the filter state object value.
      .envoy.config.core.v3.SubstitutionFormatString format_string = 2;

    • getReadOnly

      boolean getReadOnly()
       If marked as read-only, the filter state key value is locked, and cannot
 be overridden by any filter, including this filter.
      bool read_only = 3;
      Returns:
      The readOnly.

    • getSharedWithUpstreamValue

      int getSharedWithUpstreamValue()
       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.
      .envoy.extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstream shared_with_upstream = 4;
      Returns:
      The enum numeric value on the wire for sharedWithUpstream.

    • getSharedWithUpstream

      FilterStateValue.SharedWithUpstream getSharedWithUpstream()
       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.
      .envoy.extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstream shared_with_upstream = 4;
      Returns:
      The sharedWithUpstream.

    • getSkipIfEmpty

      boolean getSkipIfEmpty()
       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;
      Returns:
      The skipIfEmpty.

    • getKeyCase

      FilterStateValue.KeyCase getKeyCase()

    • getValueCase

      FilterStateValue.ValueCase getValueCase()