Class CustomTag.Metadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.type.tracing.v3.CustomTag.Metadata
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CustomTag.MetadataOrBuilder, Serializable
Enclosing class:
CustomTag

public static final class CustomTag.Metadata extends com.google.protobuf.GeneratedMessage implements CustomTag.MetadataOrBuilder
 Metadata type custom tag using
 :ref:`MetadataKey <envoy_v3_api_msg_type.metadata.v3.MetadataKey>` to retrieve the protobuf value
 from :ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`, and populate the tag value with
 `the canonical JSON <https://developers.google.com/protocol-buffers/docs/proto3#json>`_
 representation of it.
 
Protobuf type envoy.type.tracing.v3.CustomTag.Metadata
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Metadata type custom tag using :ref:`MetadataKey <envoy_v3_api_msg_type.metadata.v3.MetadataKey>` to retrieve the protobuf value from :ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`, and populate the tag value with `the canonical JSON <https://developers.google.com/protocol-buffers/docs/proto3#json>`_ representation of it.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
     
    private static final CustomTag.Metadata
     
    static final int
     
    private Object
     
    private MetadataKind
     
    static final int
     
    private byte
     
    static final int
     
    private MetadataKey
     
    private static final com.google.protobuf.Parser<CustomTag.Metadata>
     
    private static final long
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
    private
    Metadata(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
     
     
    When no valid metadata is found, the tag value would be populated with this default value if specified, otherwise no tag would be populated.
    com.google.protobuf.ByteString
    When no valid metadata is found, the tag value would be populated with this default value if specified, otherwise no tag would be populated.
    static final com.google.protobuf.Descriptors.Descriptor
     
    Specify what kind of metadata to obtain tag value from.
    Specify what kind of metadata to obtain tag value from.
    Metadata key to define the path to retrieve the tag value.
    Metadata key to define the path to retrieve the tag value.
    com.google.protobuf.Parser<CustomTag.Metadata>
     
    int
     
    int
     
    boolean
    Specify what kind of metadata to obtain tag value from.
    boolean
    Metadata key to define the path to retrieve the tag value.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CustomTag.Metadata>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • bitField0_

      private int bitField0_
    • KIND_FIELD_NUMBER

      public static final int KIND_FIELD_NUMBER
      See Also:
    • kind_

      private MetadataKind kind_
    • METADATA_KEY_FIELD_NUMBER

      public static final int METADATA_KEY_FIELD_NUMBER
      See Also:
    • metadataKey_

      private MetadataKey metadataKey_
    • DEFAULT_VALUE_FIELD_NUMBER

      public static final int DEFAULT_VALUE_FIELD_NUMBER
      See Also:
    • defaultValue_

      private volatile Object defaultValue_
    • memoizedIsInitialized

      private byte memoizedIsInitialized
    • DEFAULT_INSTANCE

      private static final CustomTag.Metadata DEFAULT_INSTANCE
    • PARSER

      private static final com.google.protobuf.Parser<CustomTag.Metadata> PARSER
  • Constructor Details

    • Metadata

      private Metadata(com.google.protobuf.GeneratedMessage.Builder<?> builder)
    • Metadata

      private Metadata()
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • hasKind

      public boolean hasKind()
       Specify what kind of metadata to obtain tag value from.
       
      .envoy.type.metadata.v3.MetadataKind kind = 1;
      Specified by:
      hasKind in interface CustomTag.MetadataOrBuilder
      Returns:
      Whether the kind field is set.
    • getKind

      public MetadataKind getKind()
       Specify what kind of metadata to obtain tag value from.
       
      .envoy.type.metadata.v3.MetadataKind kind = 1;
      Specified by:
      getKind in interface CustomTag.MetadataOrBuilder
      Returns:
      The kind.
    • getKindOrBuilder

      public MetadataKindOrBuilder getKindOrBuilder()
       Specify what kind of metadata to obtain tag value from.
       
      .envoy.type.metadata.v3.MetadataKind kind = 1;
      Specified by:
      getKindOrBuilder in interface CustomTag.MetadataOrBuilder
    • hasMetadataKey

      public boolean hasMetadataKey()
       Metadata key to define the path to retrieve the tag value.
       
      .envoy.type.metadata.v3.MetadataKey metadata_key = 2;
      Specified by:
      hasMetadataKey in interface CustomTag.MetadataOrBuilder
      Returns:
      Whether the metadataKey field is set.
    • getMetadataKey

      public MetadataKey getMetadataKey()
       Metadata key to define the path to retrieve the tag value.
       
      .envoy.type.metadata.v3.MetadataKey metadata_key = 2;
      Specified by:
      getMetadataKey in interface CustomTag.MetadataOrBuilder
      Returns:
      The metadataKey.
    • getMetadataKeyOrBuilder

      public MetadataKeyOrBuilder getMetadataKeyOrBuilder()
       Metadata key to define the path to retrieve the tag value.
       
      .envoy.type.metadata.v3.MetadataKey metadata_key = 2;
      Specified by:
      getMetadataKeyOrBuilder in interface CustomTag.MetadataOrBuilder
    • getDefaultValue

      public String getDefaultValue()
       When no valid metadata is found,
       the tag value would be populated with this default value if specified,
       otherwise no tag would be populated.
       
      string default_value = 3;
      Specified by:
      getDefaultValue in interface CustomTag.MetadataOrBuilder
      Returns:
      The defaultValue.
    • getDefaultValueBytes

      public com.google.protobuf.ByteString getDefaultValueBytes()
       When no valid metadata is found,
       the tag value would be populated with this default value if specified,
       otherwise no tag would be populated.
       
      string default_value = 3;
      Specified by:
      getDefaultValueBytes in interface CustomTag.MetadataOrBuilder
      Returns:
      The bytes for defaultValue.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 CustomTag.Metadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

      public static CustomTag.Metadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

      public static CustomTag.Metadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CustomTag.Metadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static CustomTag.Metadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static CustomTag.Metadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CustomTag.Metadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CustomTag.Metadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public CustomTag.Metadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static CustomTag.Metadata.Builder newBuilder()
    • newBuilder

      public static CustomTag.Metadata.Builder newBuilder(CustomTag.Metadata prototype)
    • toBuilder

      public CustomTag.Metadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected CustomTag.Metadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static CustomTag.Metadata getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<CustomTag.Metadata> parser()
    • getParserForType

      public com.google.protobuf.Parser<CustomTag.Metadata> 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.GeneratedMessage
    • getDefaultInstanceForType

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