io.envoyproxy.envoy.type.tracing.v3

Class CustomTag

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.type.tracing.v3.CustomTag

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CustomTagOrBuilder, Serializable

public final class CustomTag
extends com.google.protobuf.GeneratedMessageV3
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 and 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_api_msg_type.metadata.v3.MetadataKey>` to retrieve the protobuf value from :ref:`Metadata <envoy_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.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENVIRONMENT_FIELD_NUMBER
static int	LITERAL_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	REQUEST_HEADER_FIELD_NUMBER
static int	TAG_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 and Description
boolean	equals(Object obj)
static CustomTag	getDefaultInstance()
CustomTag	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
CustomTag.Environment	getEnvironment() An environment custom tag.
CustomTag.EnvironmentOrBuilder	getEnvironmentOrBuilder() An environment custom tag.
CustomTag.Literal	getLiteral() A literal custom tag.
CustomTag.LiteralOrBuilder	getLiteralOrBuilder() A literal custom tag.
CustomTag.Metadata	getMetadata() A custom tag to obtain tag value from the metadata.
CustomTag.MetadataOrBuilder	getMetadataOrBuilder() A custom tag to obtain tag value from the metadata.
com.google.protobuf.Parser<CustomTag>	getParserForType()
CustomTag.Header	getRequestHeader() A request header custom tag.
CustomTag.HeaderOrBuilder	getRequestHeaderOrBuilder() A request header custom tag.
int	getSerializedSize()
String	getTag() Used to populate the tag name.
com.google.protobuf.ByteString	getTagBytes() Used to populate the tag name.
CustomTag.TypeCase	getTypeCase()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEnvironment() An environment custom tag.
int	hashCode()
boolean	hasLiteral() A literal custom tag.
boolean	hasMetadata() A custom tag to obtain tag value from the metadata.
boolean	hasRequestHeader() A request header custom tag.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CustomTag.Builder	newBuilder()
static CustomTag.Builder	newBuilder(CustomTag prototype)
CustomTag.Builder	newBuilderForType()
protected CustomTag.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CustomTag	parseDelimitedFrom(InputStream input)
static CustomTag	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTag	parseFrom(byte[] data)
static CustomTag	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTag	parseFrom(ByteBuffer data)
static CustomTag	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTag	parseFrom(com.google.protobuf.ByteString data)
static CustomTag	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTag	parseFrom(com.google.protobuf.CodedInputStream input)
static CustomTag	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomTag	parseFrom(InputStream input)
static CustomTag	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CustomTag>	parser()
CustomTag.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TAG_FIELD_NUMBER

public static final int TAG_FIELD_NUMBER

See Also:

Constant Field Values

LITERAL_FIELD_NUMBER

public static final int LITERAL_FIELD_NUMBER

See Also:

Constant Field Values

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

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getTypeCase

public CustomTag.TypeCase getTypeCase()

Specified by:

getTypeCase in interface CustomTagOrBuilder

getTag

public String getTag()

 Used to populate the tag name.
 

string tag = 1 [(.validate.rules) = { ... }

Specified by:

getTag in interface CustomTagOrBuilder

getTagBytes

public com.google.protobuf.ByteString getTagBytes()

 Used to populate the tag name.
 

string tag = 1 [(.validate.rules) = { ... }

Specified by:

getTagBytes in interface CustomTagOrBuilder

hasLiteral

public boolean hasLiteral()

 A literal custom tag.
 

.envoy.type.tracing.v3.CustomTag.Literal literal = 2;

Specified by:

hasLiteral in interface CustomTagOrBuilder

getLiteral

public CustomTag.Literal getLiteral()

 A literal custom tag.
 

.envoy.type.tracing.v3.CustomTag.Literal literal = 2;

Specified by:

getLiteral in interface CustomTagOrBuilder

getLiteralOrBuilder

public CustomTag.LiteralOrBuilder getLiteralOrBuilder()

 A literal custom tag.
 

.envoy.type.tracing.v3.CustomTag.Literal literal = 2;

Specified by:

getLiteralOrBuilder in interface CustomTagOrBuilder

hasEnvironment

public boolean hasEnvironment()

 An environment custom tag.
 

.envoy.type.tracing.v3.CustomTag.Environment environment = 3;

Specified by:

hasEnvironment in interface CustomTagOrBuilder

getEnvironment

public CustomTag.Environment getEnvironment()

 An environment custom tag.
 

.envoy.type.tracing.v3.CustomTag.Environment environment = 3;

Specified by:

getEnvironment in interface CustomTagOrBuilder

getEnvironmentOrBuilder

public CustomTag.EnvironmentOrBuilder getEnvironmentOrBuilder()

 An environment custom tag.
 

.envoy.type.tracing.v3.CustomTag.Environment environment = 3;

Specified by:

getEnvironmentOrBuilder in interface CustomTagOrBuilder

hasRequestHeader

public boolean hasRequestHeader()

 A request header custom tag.
 

.envoy.type.tracing.v3.CustomTag.Header request_header = 4;

Specified by:

hasRequestHeader in interface CustomTagOrBuilder

getRequestHeader

public CustomTag.Header getRequestHeader()

 A request header custom tag.
 

.envoy.type.tracing.v3.CustomTag.Header request_header = 4;

Specified by:

getRequestHeader in interface CustomTagOrBuilder

getRequestHeaderOrBuilder

public CustomTag.HeaderOrBuilder getRequestHeaderOrBuilder()

 A request header custom tag.
 

.envoy.type.tracing.v3.CustomTag.Header request_header = 4;

Specified by:

getRequestHeaderOrBuilder in interface CustomTagOrBuilder

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

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

getMetadataOrBuilder

public CustomTag.MetadataOrBuilder getMetadataOrBuilder()

 A custom tag to obtain tag value from the metadata.
 

.envoy.type.tracing.v3.CustomTag.Metadata metadata = 5;

Specified by:

getMetadataOrBuilder in interface CustomTagOrBuilder

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 CustomTag parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomTag parseFrom(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(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static CustomTag parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static CustomTag parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public CustomTag.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CustomTag.Builder newBuilder()

newBuilder

public static CustomTag.Builder newBuilder(CustomTag prototype)

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

getDefaultInstanceForType

public CustomTag getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder