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.
Protobuf type envoy.extensions.filters.http.composite.v3.ExecuteFilterAction
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ExecuteFilterAction.Builder
    Composite match action (see :ref:`matching docs <arch_overview_matching_api>` for more info on match actions).

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DYNAMIC_CONFIG_FIELD_NUMBER
     
    static final int
    SAMPLE_PERCENT_FIELD_NUMBER
     
    static final int
    TYPED_CONFIG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ExecuteFilterAction
    getDefaultInstance()
     
    ExecuteFilterAction
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DynamicConfig
    getDynamicConfig()
    Dynamic configuration of filter obtained via extension configuration discovery service.
    DynamicConfigOrBuilder
    getDynamicConfigOrBuilder()
    Dynamic configuration of filter obtained via extension configuration discovery service.
    com.google.protobuf.Parser<ExecuteFilterAction>
    getParserForType()
     
    RuntimeFractionalPercent
    getSamplePercent()
    Probability of the action execution.
    RuntimeFractionalPercentOrBuilder
    getSamplePercentOrBuilder()
    Probability of the action execution.
    int
    getSerializedSize()
     
    TypedExtensionConfig
    getTypedConfig()
    Filter specific configuration which depends on the filter being instantiated.
    TypedExtensionConfigOrBuilder
    getTypedConfigOrBuilder()
    Filter specific configuration which depends on the filter being instantiated.
    boolean
    hasDynamicConfig()
    Dynamic configuration of filter obtained via extension configuration discovery service.
    int
    hashCode()
     
    boolean
    hasSamplePercent()
    Probability of the action execution.
    boolean
    hasTypedConfig()
    Filter specific configuration which depends on the filter being instantiated.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ExecuteFilterAction.Builder
    newBuilder()
     
    static ExecuteFilterAction.Builder
    newBuilder(ExecuteFilterAction prototype)
     
    ExecuteFilterAction.Builder
    newBuilderForType()
     
    protected ExecuteFilterAction.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ExecuteFilterAction
    parseDelimitedFrom(InputStream input)
     
    static ExecuteFilterAction
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExecuteFilterAction
    parseFrom(byte[] data)
     
    static ExecuteFilterAction
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExecuteFilterAction
    parseFrom(com.google.protobuf.ByteString data)
     
    static ExecuteFilterAction
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExecuteFilterAction
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ExecuteFilterAction
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExecuteFilterAction
    parseFrom(InputStream input)
     
    static ExecuteFilterAction
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExecuteFilterAction
    parseFrom(ByteBuffer data)
     
    static ExecuteFilterAction
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ExecuteFilterAction>
    parser()
     
    ExecuteFilterAction.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • 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:

    • 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`` or ``dynamic_config`` 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`` or ``dynamic_config`` 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`` or ``dynamic_config`` 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`` or ``dynamic_config`` 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`` or ``dynamic_config`` 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`` or ``dynamic_config`` can be set.
      .envoy.extensions.filters.http.composite.v3.DynamicConfig dynamic_config = 2 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getDynamicConfigOrBuilder in interface ExecuteFilterActionOrBuilder

    • 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