io.envoyproxy.envoy.extensions.dynamic_modules.v3.DynamicModuleConfigOrBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

The newest version!

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/extensions/dynamic_modules/v3/dynamic_modules.proto

// Protobuf Java Version: 3.25.1
package io.envoyproxy.envoy.extensions.dynamic_modules.v3;

public interface DynamicModuleConfigOrBuilder extends
    // @@protoc_insertion_point(interface_extends:envoy.extensions.dynamic_modules.v3.DynamicModuleConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The name of the dynamic module. The client is expected to have some configuration indicating where to search for the module.
   * In Envoy, the search path can only be configured via the environment variable ``ENVOY_DYNAMIC_MODULES_SEARCH_PATH``.
   * The actual search path is ``${ENVOY_DYNAMIC_MODULES_SEARCH_PATH}/lib${name}.so``. TODO: make the search path configurable via
   * command line options.
   * 
   *
   * string name = 1 [(.validate.rules) = { ... }
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * The name of the dynamic module. The client is expected to have some configuration indicating where to search for the module.
   * In Envoy, the search path can only be configured via the environment variable ``ENVOY_DYNAMIC_MODULES_SEARCH_PATH``.
   * The actual search path is ``${ENVOY_DYNAMIC_MODULES_SEARCH_PATH}/lib${name}.so``. TODO: make the search path configurable via
   * command line options.
   * 
   *
   * string name = 1 [(.validate.rules) = { ... }
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Set true to prevent the module from being unloaded with dlclose.
   * This is useful for modules that have global state that should not be unloaded.
   * A module is closed when no more references to it exist in the process. For example,
   * no HTTP filters are using the module (e.g. after configuration update).
   * 
   *
   * bool do_not_close = 3;
   * @return The doNotClose.
   */
  boolean getDoNotClose();
}