Package io.envoyproxy.envoy.extensions.bootstrap.dynamic_modules.v3

Interface DynamicModuleBootstrapExtensionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DynamicModuleBootstrapExtension, DynamicModuleBootstrapExtension.Builder
public interface DynamicModuleBootstrapExtensionOrBuilder 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
    getExtensionConfig()
    The configuration for the extension chosen by ``extension_name``.
    com.google.protobuf.AnyOrBuilder
    getExtensionConfigOrBuilder()
    The configuration for the extension chosen by ``extension_name``.
    String
    getExtensionName()
    The name for this extension configuration.
    com.google.protobuf.ByteString
    getExtensionNameBytes()
    The name for this extension configuration.
    boolean
    hasDynamicModuleConfig()
    Specifies the shared-object level configuration.
    boolean
    hasExtensionConfig()
    The configuration for the extension chosen by ``extension_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;

    • getExtensionName

      String getExtensionName()
       The name for this extension configuration.

 This can be used to distinguish between different extension implementations inside a dynamic
 module. For example, a module can have completely different extension implementations. When Envoy
 receives this configuration, it passes the ``extension_name`` to the dynamic module's bootstrap
 extension config init function together with the ``extension_config``. That way a module can
 decide which in-module extension implementation to use based on the name at load time.

 If not specified, defaults to an empty string.
      string extension_name = 2;
      Returns:
      The extensionName.

    • getExtensionNameBytes

      com.google.protobuf.ByteString getExtensionNameBytes()
       The name for this extension configuration.

 This can be used to distinguish between different extension implementations inside a dynamic
 module. For example, a module can have completely different extension implementations. When Envoy
 receives this configuration, it passes the ``extension_name`` to the dynamic module's bootstrap
 extension config init function together with the ``extension_config``. That way a module can
 decide which in-module extension implementation to use based on the name at load time.

 If not specified, defaults to an empty string.
      string extension_name = 2;
      Returns:
      The bytes for extensionName.

    • hasExtensionConfig

      boolean hasExtensionConfig()
       The configuration for the extension chosen by ``extension_name``.

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

 For example, if a module has two extension implementations, one for configuration loading and
 one for metric initialization, ``extension_name`` is used to choose the implementation. The
 ``extension_config`` can be used to configure the specific behavior of each implementation.

 ``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
  extension_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: hello

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

    • getExtensionConfig

      com.google.protobuf.Any getExtensionConfig()
       The configuration for the extension chosen by ``extension_name``.

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

 For example, if a module has two extension implementations, one for configuration loading and
 one for metric initialization, ``extension_name`` is used to choose the implementation. The
 ``extension_config`` can be used to configure the specific behavior of each implementation.

 ``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
  extension_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: hello

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

    • getExtensionConfigOrBuilder

      com.google.protobuf.AnyOrBuilder getExtensionConfigOrBuilder()
       The configuration for the extension chosen by ``extension_name``.

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

 For example, if a module has two extension implementations, one for configuration loading and
 one for metric initialization, ``extension_name`` is used to choose the implementation. The
 ``extension_config`` can be used to configure the specific behavior of each implementation.

 ``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
  extension_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: hello

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