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

Class DynamicModuleAccessLog.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>
io.envoyproxy.envoy.extensions.access_loggers.dynamic_modules.v3.DynamicModuleAccessLog.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DynamicModuleAccessLogOrBuilder, Cloneable
Enclosing class:
DynamicModuleAccessLog
public static final class DynamicModuleAccessLog.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder> implements DynamicModuleAccessLogOrBuilder
 Configuration for the Dynamic Modules Access Logger. This logger allows loading shared object
 files via ``dlopen`` to implement custom access logging behavior.

 A module can be loaded by multiple access loggers; the module is loaded only once and shared
 across multiple logger instances.

 The access logger receives completed request information including request/response headers,
 stream info (timing, upstream info, response codes), and the log context type.
Protobuf type envoy.extensions.access_loggers.dynamic_modules.v3.DynamicModuleAccessLog

  • Method Details

    • 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.Builder<DynamicModuleAccessLog.Builder>

    • clear

      public DynamicModuleAccessLog.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • getDefaultInstanceForType

      public DynamicModuleAccessLog getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public DynamicModuleAccessLog build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public DynamicModuleAccessLog buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public DynamicModuleAccessLog.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • setField

      public DynamicModuleAccessLog.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • clearField

      public DynamicModuleAccessLog.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • clearOneof

      public DynamicModuleAccessLog.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • setRepeatedField

      public DynamicModuleAccessLog.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • addRepeatedField

      public DynamicModuleAccessLog.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • mergeFrom

      public DynamicModuleAccessLog.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DynamicModuleAccessLog.Builder>

    • mergeFrom

      public DynamicModuleAccessLog.Builder mergeFrom(DynamicModuleAccessLog other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • mergeFrom

      public DynamicModuleAccessLog.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DynamicModuleAccessLog.Builder>
      Throws:
      IOException

    • hasDynamicModuleConfig

      public boolean hasDynamicModuleConfig()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }
      Specified by:
      hasDynamicModuleConfig in interface DynamicModuleAccessLogOrBuilder
      Returns:
      Whether the dynamicModuleConfig field is set.

    • getDynamicModuleConfig

      public DynamicModuleConfig getDynamicModuleConfig()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }
      Specified by:
      getDynamicModuleConfig in interface DynamicModuleAccessLogOrBuilder
      Returns:
      The dynamicModuleConfig.

    • setDynamicModuleConfig

      public DynamicModuleAccessLog.Builder setDynamicModuleConfig(DynamicModuleConfig value)
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }

    • setDynamicModuleConfig

      public DynamicModuleAccessLog.Builder setDynamicModuleConfig(DynamicModuleConfig.Builder builderForValue)
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }

    • mergeDynamicModuleConfig

      public DynamicModuleAccessLog.Builder mergeDynamicModuleConfig(DynamicModuleConfig value)
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }

    • clearDynamicModuleConfig

      public DynamicModuleAccessLog.Builder clearDynamicModuleConfig()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }

    • getDynamicModuleConfigBuilder

      public DynamicModuleConfig.Builder getDynamicModuleConfigBuilder()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }

    • getDynamicModuleConfigOrBuilder

      public DynamicModuleConfigOrBuilder getDynamicModuleConfigOrBuilder()
       Specifies the shared-object level configuration. This field is required.
      .envoy.extensions.dynamic_modules.v3.DynamicModuleConfig dynamic_module_config = 1 [(.validate.rules) = { ... }
      Specified by:
      getDynamicModuleConfigOrBuilder in interface DynamicModuleAccessLogOrBuilder

    • getLoggerName

      public String getLoggerName()
       The name for this logger configuration. If not specified, defaults to an empty string.

 This can be used to distinguish between different logger implementations inside a dynamic
 module. For example, a module can have completely different logger implementations (e.g.,
 file logger, gRPC logger, metrics logger). When Envoy receives this configuration, it passes
 the ``logger_name`` to the dynamic module's access logger config init function together with
 the ``logger_config``. That way a module can decide which in-module logger implementation to
 use based on the name at load time.
      string logger_name = 2;
      Specified by:
      getLoggerName in interface DynamicModuleAccessLogOrBuilder
      Returns:
      The loggerName.

    • getLoggerNameBytes

      public com.google.protobuf.ByteString getLoggerNameBytes()
       The name for this logger configuration. If not specified, defaults to an empty string.

 This can be used to distinguish between different logger implementations inside a dynamic
 module. For example, a module can have completely different logger implementations (e.g.,
 file logger, gRPC logger, metrics logger). When Envoy receives this configuration, it passes
 the ``logger_name`` to the dynamic module's access logger config init function together with
 the ``logger_config``. That way a module can decide which in-module logger implementation to
 use based on the name at load time.
      string logger_name = 2;
      Specified by:
      getLoggerNameBytes in interface DynamicModuleAccessLogOrBuilder
      Returns:
      The bytes for loggerName.

    • setLoggerName

      public DynamicModuleAccessLog.Builder setLoggerName(String value)
       The name for this logger configuration. If not specified, defaults to an empty string.

 This can be used to distinguish between different logger implementations inside a dynamic
 module. For example, a module can have completely different logger implementations (e.g.,
 file logger, gRPC logger, metrics logger). When Envoy receives this configuration, it passes
 the ``logger_name`` to the dynamic module's access logger config init function together with
 the ``logger_config``. That way a module can decide which in-module logger implementation to
 use based on the name at load time.
      string logger_name = 2;
      Parameters:
      value - The loggerName to set.
      Returns:
      This builder for chaining.

    • clearLoggerName

      public DynamicModuleAccessLog.Builder clearLoggerName()
       The name for this logger configuration. If not specified, defaults to an empty string.

 This can be used to distinguish between different logger implementations inside a dynamic
 module. For example, a module can have completely different logger implementations (e.g.,
 file logger, gRPC logger, metrics logger). When Envoy receives this configuration, it passes
 the ``logger_name`` to the dynamic module's access logger config init function together with
 the ``logger_config``. That way a module can decide which in-module logger implementation to
 use based on the name at load time.
      string logger_name = 2;
      Returns:
      This builder for chaining.

    • setLoggerNameBytes

      public DynamicModuleAccessLog.Builder setLoggerNameBytes(com.google.protobuf.ByteString value)
       The name for this logger configuration. If not specified, defaults to an empty string.

 This can be used to distinguish between different logger implementations inside a dynamic
 module. For example, a module can have completely different logger implementations (e.g.,
 file logger, gRPC logger, metrics logger). When Envoy receives this configuration, it passes
 the ``logger_name`` to the dynamic module's access logger config init function together with
 the ``logger_config``. That way a module can decide which in-module logger implementation to
 use based on the name at load time.
      string logger_name = 2;
      Parameters:
      value - The bytes for loggerName to set.
      Returns:
      This builder for chaining.

    • hasLoggerConfig

      public boolean hasLoggerConfig()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;
      Specified by:
      hasLoggerConfig in interface DynamicModuleAccessLogOrBuilder
      Returns:
      Whether the loggerConfig field is set.

    • getLoggerConfig

      public com.google.protobuf.Any getLoggerConfig()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;
      Specified by:
      getLoggerConfig in interface DynamicModuleAccessLogOrBuilder
      Returns:
      The loggerConfig.

    • setLoggerConfig

      public DynamicModuleAccessLog.Builder setLoggerConfig(com.google.protobuf.Any value)
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;

    • setLoggerConfig

      public DynamicModuleAccessLog.Builder setLoggerConfig(com.google.protobuf.Any.Builder builderForValue)
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;

    • mergeLoggerConfig

      public DynamicModuleAccessLog.Builder mergeLoggerConfig(com.google.protobuf.Any value)
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;

    • clearLoggerConfig

      public DynamicModuleAccessLog.Builder clearLoggerConfig()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;

    • getLoggerConfigBuilder

      public com.google.protobuf.Any.Builder getLoggerConfigBuilder()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;

    • getLoggerConfigOrBuilder

      public com.google.protobuf.AnyOrBuilder getLoggerConfigOrBuilder()
       The configuration for the logger chosen by ``logger_name``. If not specified, an empty
 configuration is passed to the module.

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

 For example, if a module has two logger implementations, one for file output and one for
 sending to an external service, ``logger_name`` is used to choose either file or external.
 The ``logger_config`` can be used to configure file paths, service endpoints, batching
 parameters, format strings, etc.

 ``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 JSON struct configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.Struct"
    value:
      output_path: "/var/log/envoy/access.log"
      format: "json"
      buffer_size: 1000

  # Passing a simple string configuration
  logger_config:
    "@type": "type.googleapis.com/google.protobuf.StringValue"
    value: "/var/log/envoy/access.log"
      .google.protobuf.Any logger_config = 3;
      Specified by:
      getLoggerConfigOrBuilder in interface DynamicModuleAccessLogOrBuilder

    • setUnknownFields

      public final DynamicModuleAccessLog.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>

    • mergeUnknownFields

      public final DynamicModuleAccessLog.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicModuleAccessLog.Builder>