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

Class DynamicModuleFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.dynamic_modules.v3.DynamicModuleFilter
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DynamicModuleFilterOrBuilder, Serializable
public final class DynamicModuleFilter extends com.google.protobuf.GeneratedMessageV3 implements DynamicModuleFilterOrBuilder
 Configuration for the Dynamic Modules HTTP filter. This filter allows loading shared object files
 that can be loaded via ``dlopen`` to extend the HTTP filter chain.

 A module can be loaded by multiple HTTP filters; the module is loaded only once and shared across
 multiple filters.

 A dynamic module HTTP filter can opt into being a terminal filter with no upstream by setting
 :ref:`terminal_filter
 <envoy_v3_api_field_extensions.filters.http.dynamic_modules.v3.DynamicModuleFilter.terminal_filter>`
 to ``true``. A terminal dynamic module can use ``send_`` ABI methods to send response headers,
 body, and trailers to the downstream.
Protobuf type envoy.extensions.filters.http.dynamic_modules.v3.DynamicModuleFilter
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DynamicModuleFilter.Builder
    Configuration for the Dynamic Modules HTTP filter.

    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_MODULE_CONFIG_FIELD_NUMBER
     
    static final int
    FILTER_CONFIG_FIELD_NUMBER
     
    static final int
    FILTER_NAME_FIELD_NUMBER
     
    static final int
    TERMINAL_FILTER_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 DynamicModuleFilter
    getDefaultInstance()
     
    DynamicModuleFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DynamicModuleConfig
    getDynamicModuleConfig()
    Specifies the shared-object level configuration.
    DynamicModuleConfigOrBuilder
    getDynamicModuleConfigOrBuilder()
    Specifies the shared-object level configuration.
    com.google.protobuf.Any
    getFilterConfig()
    The configuration for the filter chosen by ``filter_name``.
    com.google.protobuf.AnyOrBuilder
    getFilterConfigOrBuilder()
    The configuration for the filter chosen by ``filter_name``.
    String
    getFilterName()
    The name for this filter configuration.
    com.google.protobuf.ByteString
    getFilterNameBytes()
    The name for this filter configuration.
    com.google.protobuf.Parser<DynamicModuleFilter>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    getTerminalFilter()
    If ``true``, the dynamic module is a terminal filter to use without an upstream.
    boolean
    hasDynamicModuleConfig()
    Specifies the shared-object level configuration.
    boolean
    hasFilterConfig()
    The configuration for the filter chosen by ``filter_name``.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DynamicModuleFilter.Builder
    newBuilder()
     
    static DynamicModuleFilter.Builder
    newBuilder(DynamicModuleFilter prototype)
     
    DynamicModuleFilter.Builder
    newBuilderForType()
     
    protected DynamicModuleFilter.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static DynamicModuleFilter
    parseDelimitedFrom(InputStream input)
     
    static DynamicModuleFilter
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DynamicModuleFilter
    parseFrom(byte[] data)
     
    static DynamicModuleFilter
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DynamicModuleFilter
    parseFrom(com.google.protobuf.ByteString data)
     
    static DynamicModuleFilter
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DynamicModuleFilter
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DynamicModuleFilter
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DynamicModuleFilter
    parseFrom(InputStream input)
     
    static DynamicModuleFilter
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DynamicModuleFilter
    parseFrom(ByteBuffer data)
     
    static DynamicModuleFilter
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DynamicModuleFilter>
    parser()
     
    DynamicModuleFilter.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

    • DYNAMIC_MODULE_CONFIG_FIELD_NUMBER

      public static final int DYNAMIC_MODULE_CONFIG_FIELD_NUMBER
      See Also:

    • FILTER_NAME_FIELD_NUMBER

      public static final int FILTER_NAME_FIELD_NUMBER
      See Also:

    • FILTER_CONFIG_FIELD_NUMBER

      public static final int FILTER_CONFIG_FIELD_NUMBER
      See Also:

    • TERMINAL_FILTER_FIELD_NUMBER

      public static final int TERMINAL_FILTER_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

    • hasDynamicModuleConfig

      public boolean hasDynamicModuleConfig()
       Specifies the shared-object level configuration.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1;
      Specified by:
      hasDynamicModuleConfig in interface DynamicModuleFilterOrBuilder
      Returns:
      Whether the dynamicModuleConfig field is set.

    • getDynamicModuleConfig

      public DynamicModuleConfig getDynamicModuleConfig()
       Specifies the shared-object level configuration.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1;
      Specified by:
      getDynamicModuleConfig in interface DynamicModuleFilterOrBuilder
      Returns:
      The dynamicModuleConfig.

    • getDynamicModuleConfigOrBuilder

      public DynamicModuleConfigOrBuilder getDynamicModuleConfigOrBuilder()
       Specifies the shared-object level configuration.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1;
      Specified by:
      getDynamicModuleConfigOrBuilder in interface DynamicModuleFilterOrBuilder

    • getFilterName

      public String getFilterName()
       The name for this filter configuration.

 This can be used to distinguish between different filter implementations inside a dynamic
 module. For example, a module can have completely different filter implementations. When Envoy
 receives this configuration, it passes the ``filter_name`` to the dynamic module's HTTP filter
 config init function together with the ``filter_config``. That way a module can decide which
 in-module filter implementation to use based on the name at load time.
      string filter_name = 2;
      Specified by:
      getFilterName in interface DynamicModuleFilterOrBuilder
      Returns:
      The filterName.

    • getFilterNameBytes

      public com.google.protobuf.ByteString getFilterNameBytes()
       The name for this filter configuration.

 This can be used to distinguish between different filter implementations inside a dynamic
 module. For example, a module can have completely different filter implementations. When Envoy
 receives this configuration, it passes the ``filter_name`` to the dynamic module's HTTP filter
 config init function together with the ``filter_config``. That way a module can decide which
 in-module filter implementation to use based on the name at load time.
      string filter_name = 2;
      Specified by:
      getFilterNameBytes in interface DynamicModuleFilterOrBuilder
      Returns:
      The bytes for filterName.

    • hasFilterConfig

      public boolean hasFilterConfig()
       The configuration for the filter chosen by ``filter_name``.

 This is passed to the module's HTTP filter initialization function. Together with the
 ``filter_name``, the module can decide which in-module filter implementation to use and
 fine-tune the behavior of the filter.

 For example, if a module has two filter implementations, one for logging and one for header
 manipulation, ``filter_name`` is used to choose either logging or header manipulation. The
 ``filter_config`` can be used to configure the logging level or the header manipulation
 behavior.

 ``google.protobuf.Struct`` is serialized as JSON before passing it to the plugin.
 ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly without
 the wrapper.

 .. code-block:: yaml

  # Passing in a string
  filter_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: hello

  # Passing in raw bytes
  filter_config:
    "@type": "type.googleapis.com/google.protobuf.BytesValue"
    value: aGVsbG8= # echo -n "hello" | base64
      .google.protobuf.Any filter_config = 3;
      Specified by:
      hasFilterConfig in interface DynamicModuleFilterOrBuilder
      Returns:
      Whether the filterConfig field is set.

    • getFilterConfig

      public com.google.protobuf.Any getFilterConfig()
       The configuration for the filter chosen by ``filter_name``.

 This is passed to the module's HTTP filter initialization function. Together with the
 ``filter_name``, the module can decide which in-module filter implementation to use and
 fine-tune the behavior of the filter.

 For example, if a module has two filter implementations, one for logging and one for header
 manipulation, ``filter_name`` is used to choose either logging or header manipulation. The
 ``filter_config`` can be used to configure the logging level or the header manipulation
 behavior.

 ``google.protobuf.Struct`` is serialized as JSON before passing it to the plugin.
 ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly without
 the wrapper.

 .. code-block:: yaml

  # Passing in a string
  filter_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: hello

  # Passing in raw bytes
  filter_config:
    "@type": "type.googleapis.com/google.protobuf.BytesValue"
    value: aGVsbG8= # echo -n "hello" | base64
      .google.protobuf.Any filter_config = 3;
      Specified by:
      getFilterConfig in interface DynamicModuleFilterOrBuilder
      Returns:
      The filterConfig.

    • getFilterConfigOrBuilder

      public com.google.protobuf.AnyOrBuilder getFilterConfigOrBuilder()
       The configuration for the filter chosen by ``filter_name``.

 This is passed to the module's HTTP filter initialization function. Together with the
 ``filter_name``, the module can decide which in-module filter implementation to use and
 fine-tune the behavior of the filter.

 For example, if a module has two filter implementations, one for logging and one for header
 manipulation, ``filter_name`` is used to choose either logging or header manipulation. The
 ``filter_config`` can be used to configure the logging level or the header manipulation
 behavior.

 ``google.protobuf.Struct`` is serialized as JSON before passing it to the plugin.
 ``google.protobuf.BytesValue`` and ``google.protobuf.StringValue`` are passed directly without
 the wrapper.

 .. code-block:: yaml

  # Passing in a string
  filter_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: hello

  # Passing in raw bytes
  filter_config:
    "@type": "type.googleapis.com/google.protobuf.BytesValue"
    value: aGVsbG8= # echo -n "hello" | base64
      .google.protobuf.Any filter_config = 3;
      Specified by:
      getFilterConfigOrBuilder in interface DynamicModuleFilterOrBuilder

    • getTerminalFilter

      public boolean getTerminalFilter()
       If ``true``, the dynamic module is a terminal filter to use without an upstream.

 The dynamic module is responsible for creating and sending the response to downstream.

 Defaults to ``false``.
      bool terminal_filter = 4;
      Specified by:
      getTerminalFilter in interface DynamicModuleFilterOrBuilder
      Returns:
      The terminalFilter.

    • 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 DynamicModuleFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DynamicModuleFilter.Builder newBuilder()

    • newBuilder

      public static DynamicModuleFilter.Builder newBuilder(DynamicModuleFilter prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DynamicModuleFilter getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DynamicModuleFilter> 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 DynamicModuleFilter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder