Package io.envoyproxy.envoy.config.core.v3

Interface TlvEntryOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    SubstitutionFormatString
    getFormatString()
    Uses the :ref:`format string <config_access_log_format_strings>` to dynamically populate the TLV value from stream information.
    SubstitutionFormatStringOrBuilder
    getFormatStringOrBuilder()
    Uses the :ref:`format string <config_access_log_format_strings>` to dynamically populate the TLV value from stream information.
    int
    getType()
    The type of the TLV.
    com.google.protobuf.ByteString
    getValue()
    The static value of the TLV.
    boolean
    hasFormatString()
    Uses the :ref:`format string <config_access_log_format_strings>` to dynamically populate the TLV value from stream information.

    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

    • getType

      int getType()
       The type of the TLV. Must be a uint8 (0-255) as per the Proxy Protocol v2 specification.
      uint32 type = 1 [(.validate.rules) = { ... }
      Returns:
      The type.

    • getValue

      com.google.protobuf.ByteString getValue()
       The static value of the TLV.
 Only one of ``value`` or ``format_string`` may be set.
      bytes value = 2;
      Returns:
      The value.

    • hasFormatString

      boolean hasFormatString()
       Uses the :ref:`format string <config_access_log_format_strings>` to dynamically
 populate the TLV value from stream information. This allows dynamic values
 such as metadata, filter state, or other stream properties to be included in
 the TLV.

 For example:

 .. code-block:: yaml

   type: 0xF0
   format_string:
     text_format_source:
       inline_string: "%DYNAMIC_METADATA(envoy.filters.network:key)%"

 The formatted string will be used directly as the TLV value.
 Only one of ``value`` or ``format_string`` may be set.
      .envoy.config.core.v3.SubstitutionFormatString format_string = 3;
      Returns:
      Whether the formatString field is set.

    • getFormatString

      SubstitutionFormatString getFormatString()
       Uses the :ref:`format string <config_access_log_format_strings>` to dynamically
 populate the TLV value from stream information. This allows dynamic values
 such as metadata, filter state, or other stream properties to be included in
 the TLV.

 For example:

 .. code-block:: yaml

   type: 0xF0
   format_string:
     text_format_source:
       inline_string: "%DYNAMIC_METADATA(envoy.filters.network:key)%"

 The formatted string will be used directly as the TLV value.
 Only one of ``value`` or ``format_string`` may be set.
      .envoy.config.core.v3.SubstitutionFormatString format_string = 3;
      Returns:
      The formatString.

    • getFormatStringOrBuilder

      SubstitutionFormatStringOrBuilder getFormatStringOrBuilder()
       Uses the :ref:`format string <config_access_log_format_strings>` to dynamically
 populate the TLV value from stream information. This allows dynamic values
 such as metadata, filter state, or other stream properties to be included in
 the TLV.

 For example:

 .. code-block:: yaml

   type: 0xF0
   format_string:
     text_format_source:
       inline_string: "%DYNAMIC_METADATA(envoy.filters.network:key)%"

 The formatted string will be used directly as the TLV value.
 Only one of ``value`` or ``format_string`` may be set.
      .envoy.config.core.v3.SubstitutionFormatString format_string = 3;