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 Details

    • hasObjectKey

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

    • getObjectKey

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

    • getObjectKeyBytes

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

    • getFactoryKey

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

    • getFactoryKeyBytes

      com.google.protobuf.ByteString getFactoryKeyBytes()
       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.
      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()