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

Interface DynamicModuleNetworkFilterOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    getTerminalFilter()
    If ``true``, the dynamic module is a terminal filter to use without an upstream connection.
    boolean
    hasDynamicModuleConfig()
    Specifies the shared-object level configuration.
    boolean
    hasFilterConfig()
    The configuration for the filter chosen by ``filter_name``.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasDynamicModuleConfig

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

    • getDynamicModuleConfig

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

    • getDynamicModuleConfigOrBuilder

      DynamicModuleConfigOrBuilder getDynamicModuleConfigOrBuilder()
       Specifies the shared-object level configuration.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1;

    • getFilterName

      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 network
 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;
      Returns:
      The filterName.

    • getFilterNameBytes

      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 network
 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;
      Returns:
      The bytes for filterName.

    • hasFilterConfig

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

 This is passed to the module's network 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 echo and one for rate
 limiting, ``filter_name`` is used to choose either echo or rate limiting. The
 ``filter_config`` can be used to configure the echo behavior or the rate limiting parameters.

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

 .. code-block:: yaml

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

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

    • getFilterConfig

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

 This is passed to the module's network 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 echo and one for rate
 limiting, ``filter_name`` is used to choose either echo or rate limiting. The
 ``filter_config`` can be used to configure the echo behavior or the rate limiting parameters.

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

 .. code-block:: yaml

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

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

    • getFilterConfigOrBuilder

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

 This is passed to the module's network 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 echo and one for rate
 limiting, ``filter_name`` is used to choose either echo or rate limiting. The
 ``filter_config`` can be used to configure the echo behavior or the rate limiting parameters.

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

 .. code-block:: yaml

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

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

    • getTerminalFilter

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

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

 Defaults to ``false``.
      bool terminal_filter = 4;
      Returns:
      The terminalFilter.