Class CustomTag

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CustomTagOrBuilder, java.io.Serializable

    public final class CustomTag
    extends com.google.protobuf.GeneratedMessage
    implements CustomTagOrBuilder
     Describes custom tags for the active span.
     [#next-free-field: 6]
     
    Protobuf type envoy.type.tracing.v3.CustomTag
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CustomTag.Builder
      Describes custom tags for the active span.
      static class  CustomTag.Environment
      Environment type custom tag with environment name and default value.
      static interface  CustomTag.EnvironmentOrBuilder  
      static class  CustomTag.Header
      Header type custom tag with header name and default value.
      static interface  CustomTag.HeaderOrBuilder  
      static class  CustomTag.Literal
      Literal type custom tag with static value for the tag value.
      static interface  CustomTag.LiteralOrBuilder  
      static class  CustomTag.Metadata
      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.
      static interface  CustomTag.MetadataOrBuilder  
      static class  CustomTag.TypeCase  
      • 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 extends java.lang.Object>, 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
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private CustomTag()  
      private CustomTag​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Field Detail

      • typeCase_

        private int typeCase_
      • type_

        private java.lang.Object type_
      • tag_

        private volatile java.lang.Object tag_
      • ENVIRONMENT_FIELD_NUMBER

        public static final int ENVIRONMENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REQUEST_HEADER_FIELD_NUMBER

        public static final int REQUEST_HEADER_FIELD_NUMBER
        See Also:
        Constant Field Values
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final CustomTag DEFAULT_INSTANCE
      • PARSER

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

      • CustomTag

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

        private CustomTag()
    • Method Detail

      • 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
      • getTag

        public java.lang.String getTag()
         Used to populate the tag name.
         
        string tag = 1 [(.validate.rules) = { ... }
        Specified by:
        getTag in interface CustomTagOrBuilder
        Returns:
        The tag.
      • getTagBytes

        public com.google.protobuf.ByteString getTagBytes()
         Used to populate the tag name.
         
        string tag = 1 [(.validate.rules) = { ... }
        Specified by:
        getTagBytes in interface CustomTagOrBuilder
        Returns:
        The bytes for tag.
      • hasLiteral

        public boolean hasLiteral()
         A literal custom tag.
         
        .envoy.type.tracing.v3.CustomTag.Literal literal = 2;
        Specified by:
        hasLiteral in interface CustomTagOrBuilder
        Returns:
        Whether the literal field is set.
      • hasEnvironment

        public boolean hasEnvironment()
         An environment custom tag.
         
        .envoy.type.tracing.v3.CustomTag.Environment environment = 3;
        Specified by:
        hasEnvironment in interface CustomTagOrBuilder
        Returns:
        Whether the environment field is set.
      • hasRequestHeader

        public boolean hasRequestHeader()
         A request header custom tag.
         
        .envoy.type.tracing.v3.CustomTag.Header request_header = 4;
        Specified by:
        hasRequestHeader in interface CustomTagOrBuilder
        Returns:
        Whether the requestHeader field is set.
      • hasMetadata

        public boolean hasMetadata()
         A custom tag to obtain tag value from the metadata.
         
        .envoy.type.tracing.v3.CustomTag.Metadata metadata = 5;
        Specified by:
        hasMetadata in interface CustomTagOrBuilder
        Returns:
        Whether the metadata field is set.
      • getMetadata

        public CustomTag.Metadata getMetadata()
         A custom tag to obtain tag value from the metadata.
         
        .envoy.type.tracing.v3.CustomTag.Metadata metadata = 5;
        Specified by:
        getMetadata in interface CustomTagOrBuilder
        Returns:
        The metadata.
      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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 parseFrom​(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

        public static CustomTag 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 parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static CustomTag parseFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public static CustomTag parseDelimitedFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

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

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

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

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

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

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

        public static CustomTag getDefaultInstance()
      • parser

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

        public com.google.protobuf.Parser<CustomTag> 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 getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder