com.google.devtools.cloudtrace.v1

Interface TraceSpanOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TraceSpan, TraceSpan.Builder

public interface TraceSpanOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) Collection of labels associated with the span.
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.
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.
boolean	hasEndTime() End time of the span in nanoseconds from the UNIX epoch.
boolean	hasStartTime() Start time of the span in nanoseconds from the UNIX epoch.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSpanId

long getSpanId()

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

optional fixed64 span_id = 1;

getKindValue

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.
 

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

getKind

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.
 

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

getName

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.
 

optional string name = 3;

getNameBytes

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.
 

optional string name = 3;

hasStartTime

boolean hasStartTime()

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

optional .google.protobuf.Timestamp start_time = 4;

getStartTime

com.google.protobuf.Timestamp getStartTime()

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

optional .google.protobuf.Timestamp start_time = 4;

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

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

optional .google.protobuf.Timestamp start_time = 4;

hasEndTime

boolean hasEndTime()

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

optional .google.protobuf.Timestamp end_time = 5;

getEndTime

com.google.protobuf.Timestamp getEndTime()

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

optional .google.protobuf.Timestamp end_time = 5;

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

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

optional .google.protobuf.Timestamp end_time = 5;

getParentSpanId

long getParentSpanId()

 ID of the parent span, if any. Optional.
 

optional fixed64 parent_span_id = 6;

getLabelsCount

int getLabelsCount()

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

containsLabels

boolean containsLabels(java.lang.String key)

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

getLabels

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

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

getLabelsOrDefault

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

 Collection of labels associated with the span.
 

map<string, string> labels = 7;

getLabelsOrThrow

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

 Collection of labels associated with the span.
 

map<string, string> labels = 7;