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

Class TlvEntry

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.core.v3.TlvEntry
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TlvEntryOrBuilder, Serializable
public final class TlvEntry extends com.google.protobuf.GeneratedMessageV3 implements TlvEntryOrBuilder
 Represents a single Type-Length-Value (TLV) entry.
Protobuf type envoy.config.core.v3.TlvEntry
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TlvEntry.Builder
    Represents a single Type-Length-Value (TLV) entry.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FORMAT_STRING_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     
    static final int
    VALUE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static TlvEntry
    getDefaultInstance()
     
    TlvEntry
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<TlvEntry>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TlvEntry.Builder
    newBuilder()
     
    static TlvEntry.Builder
    newBuilder(TlvEntry prototype)
     
    TlvEntry.Builder
    newBuilderForType()
     
    protected TlvEntry.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static TlvEntry
    parseDelimitedFrom(InputStream input)
     
    static TlvEntry
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TlvEntry
    parseFrom(byte[] data)
     
    static TlvEntry
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TlvEntry
    parseFrom(com.google.protobuf.ByteString data)
     
    static TlvEntry
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TlvEntry
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TlvEntry
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TlvEntry
    parseFrom(InputStream input)
     
    static TlvEntry
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TlvEntry
    parseFrom(ByteBuffer data)
     
    static TlvEntry
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TlvEntry>
    parser()
     
    TlvEntry.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • getType

      public 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) = { ... }
      Specified by:
      getType in interface TlvEntryOrBuilder
      Returns:
      The type.

    • getValue

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

    • hasFormatString

      public 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;
      Specified by:
      hasFormatString in interface TlvEntryOrBuilder
      Returns:
      Whether the formatString field is set.

    • getFormatString

      public 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;
      Specified by:
      getFormatString in interface TlvEntryOrBuilder
      Returns:
      The formatString.

    • getFormatStringOrBuilder

      public 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;
      Specified by:
      getFormatStringOrBuilder in interface TlvEntryOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TlvEntry parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TlvEntry parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TlvEntry parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TlvEntry parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TlvEntry parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TlvEntry parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TlvEntry parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TlvEntry parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TlvEntry parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TlvEntry parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TlvEntry parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TlvEntry parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TlvEntry.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TlvEntry.Builder newBuilder()

    • newBuilder

      public static TlvEntry.Builder newBuilder(TlvEntry prototype)

    • toBuilder

      public TlvEntry.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TlvEntry.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static TlvEntry getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TlvEntry> parser()

    • getParserForType

      public com.google.protobuf.Parser<TlvEntry> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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