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

Class ExecuteFilterAction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.composite.v3.ExecuteFilterAction
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExecuteFilterActionOrBuilder, Serializable
public final class ExecuteFilterAction extends com.google.protobuf.GeneratedMessageV3 implements ExecuteFilterActionOrBuilder
 Composite match action (see :ref:`matching docs <arch_overview_matching_api>` for more info on match actions).
 This specifies the filter configuration of the filter that the composite filter should delegate filter interactions to.
 [#next-free-field: 6]
Protobuf type envoy.extensions.filters.http.composite.v3.ExecuteFilterAction
See Also:

  • Field Details

    • TYPED_CONFIG_FIELD_NUMBER

      public static final int TYPED_CONFIG_FIELD_NUMBER
      See Also:

    • DYNAMIC_CONFIG_FIELD_NUMBER

      public static final int DYNAMIC_CONFIG_FIELD_NUMBER
      See Also:

    • FILTER_CHAIN_FIELD_NUMBER

      public static final int FILTER_CHAIN_FIELD_NUMBER
      See Also:

    • FILTER_CHAIN_NAME_FIELD_NUMBER

      public static final int FILTER_CHAIN_NAME_FIELD_NUMBER
      See Also:

    • SAMPLE_PERCENT_FIELD_NUMBER

      public static final int SAMPLE_PERCENT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasTypedConfig

      public 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) = { ... }
      Specified by:
      hasTypedConfig in interface ExecuteFilterActionOrBuilder
      Returns:
      Whether the typedConfig field is set.

    • getTypedConfig

      public 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) = { ... }
      Specified by:
      getTypedConfig in interface ExecuteFilterActionOrBuilder
      Returns:
      The typedConfig.

    • getTypedConfigOrBuilder

      public 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) = { ... }
      Specified by:
      getTypedConfigOrBuilder in interface ExecuteFilterActionOrBuilder

    • hasDynamicConfig

      public 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) = { ... }
      Specified by:
      hasDynamicConfig in interface ExecuteFilterActionOrBuilder
      Returns:
      Whether the dynamicConfig field is set.

    • getDynamicConfig

      public 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) = { ... }
      Specified by:
      getDynamicConfig in interface ExecuteFilterActionOrBuilder
      Returns:
      The dynamicConfig.

    • getDynamicConfigOrBuilder

      public 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) = { ... }
      Specified by:
      getDynamicConfigOrBuilder in interface ExecuteFilterActionOrBuilder

    • hasFilterChain

      public 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;
      Specified by:
      hasFilterChain in interface ExecuteFilterActionOrBuilder
      Returns:
      Whether the filterChain field is set.

    • getFilterChain

      public 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;
      Specified by:
      getFilterChain in interface ExecuteFilterActionOrBuilder
      Returns:
      The filterChain.

    • getFilterChainOrBuilder

      public 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;
      Specified by:
      getFilterChainOrBuilder in interface ExecuteFilterActionOrBuilder

    • getFilterChainName

      public 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;
      Specified by:
      getFilterChainName in interface ExecuteFilterActionOrBuilder
      Returns:
      The filterChainName.

    • getFilterChainNameBytes

      public 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;
      Specified by:
      getFilterChainNameBytes in interface ExecuteFilterActionOrBuilder
      Returns:
      The bytes for filterChainName.

    • hasSamplePercent

      public 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;
      Specified by:
      hasSamplePercent in interface ExecuteFilterActionOrBuilder
      Returns:
      Whether the samplePercent field is set.

    • getSamplePercent

      public 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;
      Specified by:
      getSamplePercent in interface ExecuteFilterActionOrBuilder
      Returns:
      The samplePercent.

    • getSamplePercentOrBuilder

      public 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;
      Specified by:
      getSamplePercentOrBuilder in interface ExecuteFilterActionOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExecuteFilterAction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteFilterAction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteFilterAction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteFilterAction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteFilterAction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteFilterAction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExecuteFilterAction parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecuteFilterAction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExecuteFilterAction parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExecuteFilterAction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecuteFilterAction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExecuteFilterAction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExecuteFilterAction.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExecuteFilterAction.Builder newBuilder()

    • newBuilder

      public static ExecuteFilterAction.Builder newBuilder(ExecuteFilterAction prototype)

    • toBuilder

      public ExecuteFilterAction.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExecuteFilterAction.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ExecuteFilterAction getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExecuteFilterAction> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExecuteFilterAction> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ExecuteFilterAction getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder