Class SpanContext (3.33.0)

public final class SpanContext extends GeneratedMessageV3 implements SpanContextOrBuilder

The context of a span. This is attached to an Exemplar in Distribution values during aggregation.

It contains the name of a span with format:

 projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]

Protobuf type google.monitoring.v3.SpanContext

Static Fields

SPAN_NAME_FIELD_NUMBER

public static final int SPAN_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SpanContext getDefaultInstance()
Returns
TypeDescription
SpanContext

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SpanContext.Builder newBuilder()
Returns
TypeDescription
SpanContext.Builder

newBuilder(SpanContext prototype)

public static SpanContext.Builder newBuilder(SpanContext prototype)
Parameter
NameDescription
prototypeSpanContext
Returns
TypeDescription
SpanContext.Builder

parseDelimitedFrom(InputStream input)

public static SpanContext parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SpanContext parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpanContext parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpanContext parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SpanContext parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SpanContext parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpanContext
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SpanContext> parser()
Returns
TypeDescription
Parser<SpanContext>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SpanContext getDefaultInstanceForType()
Returns
TypeDescription
SpanContext

getParserForType()

public Parser<SpanContext> getParserForType()
Returns
TypeDescription
Parser<SpanContext>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpanName()

public String getSpanName()

The resource name of the span. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]

[TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.

[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.

string span_name = 1;

Returns
TypeDescription
String

The spanName.

getSpanNameBytes()

public ByteString getSpanNameBytes()

The resource name of the span. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]

[TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.

[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.

string span_name = 1;

Returns
TypeDescription
ByteString

The bytes for spanName.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SpanContext.Builder newBuilderForType()
Returns
TypeDescription
SpanContext.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SpanContext.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SpanContext.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SpanContext.Builder toBuilder()
Returns
TypeDescription
SpanContext.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException