TraceSpan (java API)

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, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class TraceSpan
extends 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
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, 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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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 Descriptors.Descriptor`	`getDescriptor()`
`Timestamp`	`getEndTime()` End time of the span in nanoseconds from the UNIX epoch.
`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 span.
`ByteString`	`getNameBytes()` Name of the span.
`long`	`getParentSpanId()` ID of the parent span, if any.
`Parser<TraceSpan>`	`getParserForType()`
`int`	`getSerializedSize()`
`long`	`getSpanId()` Identifier for the span.
`Timestamp`	`getStartTime()` Start time of the span in nanoseconds from the UNIX epoch.
`TimestampOrBuilder`	`getStartTimeOrBuilder()` Start time of the span in nanoseconds from the UNIX epoch.
`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 GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static TraceSpan.Builder`	`newBuilder()`
`static TraceSpan.Builder`	`newBuilder(TraceSpan prototype)`
`TraceSpan.Builder`	`newBuilderForType()`
`protected TraceSpan.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static TraceSpan`	`parseDelimitedFrom(java.io.InputStream input)`
`static TraceSpan`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static TraceSpan`	`parseFrom(byte[] data)`
`static TraceSpan`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static TraceSpan`	`parseFrom(java.nio.ByteBuffer data)`
`static TraceSpan`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static TraceSpan`	`parseFrom(ByteString data)`
`static TraceSpan`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static TraceSpan`	`parseFrom(CodedInputStream input)`
`static TraceSpan`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static TraceSpan`	`parseFrom(java.io.InputStream input)`
`static TraceSpan`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<TraceSpan>`	`parser()`
`TraceSpan.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

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
- 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 UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class 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 span. Must be less than 128 bytes. The span name is sanitized
 and displayed in the Stackdriver Trace tool in the
 {% dynamic print site_values.console_name %}.
 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 ByteString getNameBytes()

 Name of the span. Must be less than 128 bytes. The span name is sanitized
 and displayed in the Stackdriver Trace tool in the
 {% dynamic print site_values.console_name %}.
 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 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 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 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 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