Package io.envoyproxy.envoy.extensions.filters.http.composite.v3

Interface ExecuteFilterActionOrBuilder

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

  • Method Details

    • hasTypedConfig

      boolean hasTypedConfig()
       Filter specific configuration which depends on the filter being
 instantiated. See the supported filters for further documentation.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
 [#extension-category: envoy.filters.http]
      .envoy.config.core.v3.TypedExtensionConfig typed_config = 1 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the typedConfig field is set.

    • getTypedConfig

      TypedExtensionConfig getTypedConfig()
       Filter specific configuration which depends on the filter being
 instantiated. See the supported filters for further documentation.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
 [#extension-category: envoy.filters.http]
      .envoy.config.core.v3.TypedExtensionConfig typed_config = 1 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The typedConfig.

    • getTypedConfigOrBuilder

      TypedExtensionConfigOrBuilder getTypedConfigOrBuilder()
       Filter specific configuration which depends on the filter being
 instantiated. See the supported filters for further documentation.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
 [#extension-category: envoy.filters.http]
      .envoy.config.core.v3.TypedExtensionConfig typed_config = 1 [(.udpa.annotations.field_migrate) = { ... }

    • hasDynamicConfig

      boolean hasDynamicConfig()
       Dynamic configuration of filter obtained via extension configuration discovery service.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      .envoy.extensions.filters.http.composite.v3.DynamicConfig dynamic_config = 2 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the dynamicConfig field is set.

    • getDynamicConfig

      DynamicConfig getDynamicConfig()
       Dynamic configuration of filter obtained via extension configuration discovery service.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      .envoy.extensions.filters.http.composite.v3.DynamicConfig dynamic_config = 2 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The dynamicConfig.

    • getDynamicConfigOrBuilder

      DynamicConfigOrBuilder getDynamicConfigOrBuilder()
       Dynamic configuration of filter obtained via extension configuration discovery service.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      .envoy.extensions.filters.http.composite.v3.DynamicConfig dynamic_config = 2 [(.udpa.annotations.field_migrate) = { ... }

    • hasFilterChain

      boolean hasFilterChain()
       An inlined list of filter configurations. The specified filters will be executed in order.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration filter_chain = 4;
      Returns:
      Whether the filterChain field is set.

    • getFilterChain

      FilterChainConfiguration getFilterChain()
       An inlined list of filter configurations. The specified filters will be executed in order.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration filter_chain = 4;
      Returns:
      The filterChain.

    • getFilterChainOrBuilder

      FilterChainConfigurationOrBuilder getFilterChainOrBuilder()
       An inlined list of filter configurations. The specified filters will be executed in order.
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      .envoy.extensions.filters.http.composite.v3.FilterChainConfiguration filter_chain = 4;

    • getFilterChainName

      String getFilterChainName()
       The name of a filter chain defined in
 :ref:`Composite.named_filter_chains
 <envoy_v3_api_field_extensions.filters.http.composite.v3.Composite.named_filter_chains>`.
 At runtime, if the named filter chain is not found in the Composite filter's configuration,
 no filter will be applied for this match (the action is silently skipped).
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      string filter_chain_name = 5;
      Returns:
      The filterChainName.

    • getFilterChainNameBytes

      com.google.protobuf.ByteString getFilterChainNameBytes()
       The name of a filter chain defined in
 :ref:`Composite.named_filter_chains
 <envoy_v3_api_field_extensions.filters.http.composite.v3.Composite.named_filter_chains>`.
 At runtime, if the named filter chain is not found in the Composite filter's configuration,
 no filter will be applied for this match (the action is silently skipped).
 Only one of ``typed_config``, ``dynamic_config``, ``filter_chain``, or ``filter_chain_name``
 can be set.
      string filter_chain_name = 5;
      Returns:
      The bytes for filterChainName.

    • hasSamplePercent

      boolean hasSamplePercent()
       Probability of the action execution. If not specified, this is 100%.
 This allows sampling behavior for the configured actions.
 For example, if
 :ref:`default_value <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.default_value>`
 under the ``sample_percent`` is configured with 30%, a dice roll with that
 probability is done. The underline action will only be executed if the
 dice roll returns positive. Otherwise, the action is skipped.
      .envoy.config.core.v3.RuntimeFractionalPercent sample_percent = 3;
      Returns:
      Whether the samplePercent field is set.

    • getSamplePercent

      RuntimeFractionalPercent getSamplePercent()
       Probability of the action execution. If not specified, this is 100%.
 This allows sampling behavior for the configured actions.
 For example, if
 :ref:`default_value <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.default_value>`
 under the ``sample_percent`` is configured with 30%, a dice roll with that
 probability is done. The underline action will only be executed if the
 dice roll returns positive. Otherwise, the action is skipped.
      .envoy.config.core.v3.RuntimeFractionalPercent sample_percent = 3;
      Returns:
      The samplePercent.

    • getSamplePercentOrBuilder

      RuntimeFractionalPercentOrBuilder getSamplePercentOrBuilder()
       Probability of the action execution. If not specified, this is 100%.
 This allows sampling behavior for the configured actions.
 For example, if
 :ref:`default_value <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.default_value>`
 under the ``sample_percent`` is configured with 30%, a dice roll with that
 probability is done. The underline action will only be executed if the
 dice roll returns positive. Otherwise, the action is skipped.
      .envoy.config.core.v3.RuntimeFractionalPercent sample_percent = 3;