com.google.devtools.cloudtrace.v1

Class TraceSpan

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.devtools.cloudtrace.v1.TraceSpan

All Implemented Interfaces:

TraceSpanOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class TraceSpan
extends com.google.protobuf.GeneratedMessageV3
implements TraceSpanOrBuilder

 A span represents a single timed event within a trace. Spans can be nested
 and form a trace tree. Often, a trace contains a root span that describes the
 end-to-end latency of an operation and, optionally, one or more subspans for
 its suboperations. Spans do not need to be contiguous. There may be gaps
 between spans in a trace.
 

Protobuf type google.devtools.cloudtrace.v1.TraceSpan

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TraceSpan.Builder A span represents a single timed event within a trace.
static class	TraceSpan.SpanKind Type of span.

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_TIME_FIELD_NUMBER
static int	KIND_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PARENT_SPAN_ID_FIELD_NUMBER
static int	SPAN_ID_FIELD_NUMBER
static int	START_TIME_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	containsLabels(java.lang.String key) Collection of labels associated with the span.
boolean	equals(java.lang.Object obj)
static TraceSpan	getDefaultInstance()
TraceSpan	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getEndTime() End time of the span in nanoseconds from the UNIX epoch.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() End time of the span in nanoseconds from the UNIX epoch.
TraceSpan.SpanKind	getKind() Distinguishes between spans generated in a particular context.
int	getKindValue() Distinguishes between spans generated in a particular context.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Collection of labels associated with the span.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Collection of labels associated with the span.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Collection of labels associated with the span.
java.lang.String	getLabelsOrThrow(java.lang.String key) Collection of labels associated with the span.
java.lang.String	getName() Name of the trace.
com.google.protobuf.ByteString	getNameBytes() Name of the trace.
long	getParentSpanId() ID of the parent span, if any.
com.google.protobuf.Parser<TraceSpan>	getParserForType()
int	getSerializedSize()
long	getSpanId() Identifier for the span.
com.google.protobuf.Timestamp	getStartTime() Start time of the span in nanoseconds from the UNIX epoch.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Start time of the span in nanoseconds from the UNIX epoch.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEndTime() End time of the span in nanoseconds from the UNIX epoch.
int	hashCode()
boolean	hasStartTime() Start time of the span in nanoseconds from the UNIX epoch.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static TraceSpan.Builder	newBuilder()
static TraceSpan.Builder	newBuilder(TraceSpan prototype)
TraceSpan.Builder	newBuilderForType()
protected TraceSpan.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static TraceSpan	parseDelimitedFrom(java.io.InputStream input)
static TraceSpan	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TraceSpan	parseFrom(byte[] data)
static TraceSpan	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TraceSpan	parseFrom(com.google.protobuf.ByteString data)
static TraceSpan	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TraceSpan	parseFrom(com.google.protobuf.CodedInputStream input)
static TraceSpan	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TraceSpan	parseFrom(java.io.InputStream input)
static TraceSpan	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TraceSpan>	parser()
TraceSpan.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, 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, 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

SPAN_ID_FIELD_NUMBER

public static final int SPAN_ID_FIELD_NUMBER

See Also:

Constant Field Values

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

PARENT_SPAN_ID_FIELD_NUMBER

public static final int PARENT_SPAN_ID_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSpanId

public long getSpanId()

 Identifier for the span. Must be a 64-bit integer other than 0 and
 unique within a trace.
 

fixed64 span_id = 1;

Specified by:

getSpanId in interface TraceSpanOrBuilder

getKindValue

public int getKindValue()

 Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `RPC_CLIENT`
 and `RPC_SERVER` to identify queueing latency associated with the span.
 

.google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;

Specified by:

getKindValue in interface TraceSpanOrBuilder

getKind

public TraceSpan.SpanKind getKind()

 Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `RPC_CLIENT`
 and `RPC_SERVER` to identify queueing latency associated with the span.
 

.google.devtools.cloudtrace.v1.TraceSpan.SpanKind kind = 2;

Specified by:

getKind in interface TraceSpanOrBuilder

getName

public java.lang.String getName()

 Name of the trace. The trace name is sanitized and displayed in the
 Stackdriver Trace tool in the Google Developers Console.
 The name may be a method name or some other per-call site name.
 For the same executable and the same call point, a best practice is
 to use a consistent name, which makes it easier to correlate
 cross-trace spans.
 

string name = 3;

Specified by:

getName in interface TraceSpanOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Name of the trace. The trace name is sanitized and displayed in the
 Stackdriver Trace tool in the Google Developers Console.
 The name may be a method name or some other per-call site name.
 For the same executable and the same call point, a best practice is
 to use a consistent name, which makes it easier to correlate
 cross-trace spans.
 

string name = 3;

Specified by:

getNameBytes in interface TraceSpanOrBuilder

hasStartTime

public boolean hasStartTime()

 Start time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp start_time = 4;

Specified by:

hasStartTime in interface TraceSpanOrBuilder

getStartTime

public com.google.protobuf.Timestamp getStartTime()

 Start time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp start_time = 4;

Specified by:

getStartTime in interface TraceSpanOrBuilder

getStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Start time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp start_time = 4;

Specified by:

getStartTimeOrBuilder in interface TraceSpanOrBuilder

hasEndTime

public boolean hasEndTime()

 End time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp end_time = 5;

Specified by:

hasEndTime in interface TraceSpanOrBuilder

getEndTime

public com.google.protobuf.Timestamp getEndTime()

 End time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp end_time = 5;

Specified by:

getEndTime in interface TraceSpanOrBuilder

getEndTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 End time of the span in nanoseconds from the UNIX epoch.
 

.google.protobuf.Timestamp end_time = 5;

Specified by:

getEndTimeOrBuilder in interface TraceSpanOrBuilder

getParentSpanId

public long getParentSpanId()

 ID of the parent span, if any. Optional.
 

fixed64 parent_span_id = 6;

Specified by:

getParentSpanId in interface TraceSpanOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: TraceSpanOrBuilder

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

Specified by:

getLabelsCount in interface TraceSpanOrBuilder

containsLabels

public boolean containsLabels(java.lang.String key)

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

Specified by:

containsLabels in interface TraceSpanOrBuilder

getLabels

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface TraceSpanOrBuilder

getLabelsMap

public java.util.Map<java.lang.String,java.lang.String> getLabelsMap()

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

Specified by:

getLabelsMap in interface TraceSpanOrBuilder

getLabelsOrDefault

public java.lang.String getLabelsOrDefault(java.lang.String key,
                                           java.lang.String defaultValue)

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

Specified by:

getLabelsOrDefault in interface TraceSpanOrBuilder

getLabelsOrThrow

public java.lang.String getLabelsOrThrow(java.lang.String key)

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

Specified by:

getLabelsOrThrow in interface TraceSpanOrBuilder

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 java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.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(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 TraceSpan parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TraceSpan parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TraceSpan parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TraceSpan parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TraceSpan parseFrom(java.io.InputStream input)
                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

public static TraceSpan parseDelimitedFrom(java.io.InputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

public static TraceSpan parseFrom(com.google.protobuf.CodedInputStream input)
                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public TraceSpan.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TraceSpan.Builder newBuilder()

newBuilder

public static TraceSpan.Builder newBuilder(TraceSpan prototype)

toBuilder

public TraceSpan.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TraceSpan.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TraceSpan getDefaultInstance()

parser

public static com.google.protobuf.Parser<TraceSpan> parser()

getParserForType

public com.google.protobuf.Parser<TraceSpan> 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 TraceSpan getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder