Class SpanContext (3.52.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
Type Description
int

Static Methods

getDefaultInstance()

public static SpanContext getDefaultInstance()
Returns
Type Description
SpanContext

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SpanContext.Builder newBuilder()
Returns
Type Description
SpanContext.Builder

newBuilder(SpanContext prototype)

public static SpanContext.Builder newBuilder(SpanContext prototype)
Parameter
Name Description
prototype SpanContext
Returns
Type Description
SpanContext.Builder

parseDelimitedFrom(InputStream input)

public static SpanContext parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpanContext
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpanContext
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SpanContext parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SpanContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpanContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpanContext parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SpanContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpanContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpanContext parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SpanContext
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpanContext
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SpanContext parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpanContext
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpanContext
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SpanContext parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SpanContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpanContext parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpanContext
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SpanContext> parser()
Returns
Type Description
Parser<SpanContext>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SpanContext getDefaultInstanceForType()
Returns
Type Description
SpanContext

getParserForType()

public Parser<SpanContext> getParserForType()
Returns
Type Description
Parser<SpanContext>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for spanName.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SpanContext.Builder newBuilderForType()
Returns
Type Description
SpanContext.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SpanContext.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SpanContext.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SpanContext.Builder toBuilder()
Returns
Type Description
SpanContext.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException