All Superinterfaces:

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

All Known Implementing Classes:

Span, Span.Builder
```
public interface SpanOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`KeyValue`	`getAttributes(int index)`	attributes is a collection of key/value pairs.
`int`	`getAttributesCount()`	attributes is a collection of key/value pairs.
`List<KeyValue>`	`getAttributesList()`	attributes is a collection of key/value pairs.
`KeyValueOrBuilder`	`getAttributesOrBuilder(int index)`	attributes is a collection of key/value pairs.
`List<? extends KeyValueOrBuilder>`	`getAttributesOrBuilderList()`	attributes is a collection of key/value pairs.
`int`	`getDroppedAttributesCount()`	dropped_attributes_count is the number of attributes that were discarded.
`int`	`getDroppedEventsCount()`	dropped_events_count is the number of dropped events.
`int`	`getDroppedLinksCount()`	dropped_links_count is the number of dropped links after the maximum size was enforced.
`long`	`getEndTimeUnixNano()`	end_time_unix_nano is the end time of the span.
`Span.Event`	`getEvents(int index)`	events is a collection of Event items.
`int`	`getEventsCount()`	events is a collection of Event items.
`List<Span.Event>`	`getEventsList()`	events is a collection of Event items.
`Span.EventOrBuilder`	`getEventsOrBuilder(int index)`	events is a collection of Event items.
`List<? extends Span.EventOrBuilder>`	`getEventsOrBuilderList()`	events is a collection of Event items.
`Span.SpanKind`	`getKind()`	Distinguishes between spans generated in a particular context.
`int`	`getKindValue()`	Distinguishes between spans generated in a particular context.
`Span.Link`	`getLinks(int index)`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`int`	`getLinksCount()`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`List<Span.Link>`	`getLinksList()`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`Span.LinkOrBuilder`	`getLinksOrBuilder(int index)`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`List<? extends Span.LinkOrBuilder>`	`getLinksOrBuilderList()`	links is a collection of Links, which are references from this span to a span in the same or different trace.
`String`	`getName()`	A description of the span's operation.
`com.google.protobuf.ByteString`	`getNameBytes()`	A description of the span's operation.
`com.google.protobuf.ByteString`	`getParentSpanId()`	The `span_id` of this span's parent span.
`com.google.protobuf.ByteString`	`getSpanId()`	A unique identifier for a span within a trace, assigned when the span is created.
`long`	`getStartTimeUnixNano()`	start_time_unix_nano is the start time of the span.
`Status`	`getStatus()`	An optional final status for this span.
`StatusOrBuilder`	`getStatusOrBuilder()`	An optional final status for this span.
`com.google.protobuf.ByteString`	`getTraceId()`	A unique identifier for a trace.
`String`	`getTraceState()`	trace_state conveys information about request position in multiple distributed tracing graphs.
`com.google.protobuf.ByteString`	`getTraceStateBytes()`	trace_state conveys information about request position in multiple distributed tracing graphs.
`boolean`	`hasStatus()`	An optional final status for this span.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getTraceId

com.google.protobuf.ByteString getTraceId()

 A unique identifier for a trace. All spans from the same trace share
 the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes
 is considered invalid.
 This field is semantically required. Receiver should generate new
 random trace_id if empty or invalid trace_id was received.
 This field is required.

bytes trace_id = 1;

Returns:: The traceId.

getSpanId

com.google.protobuf.ByteString getSpanId()

 A unique identifier for a span within a trace, assigned when the span
 is created. The ID is an 8-byte array. An ID with all zeroes is considered
 invalid.
 This field is semantically required. Receiver should generate new
 random span_id if empty or invalid span_id was received.
 This field is required.

bytes span_id = 2;

Returns:: The spanId.

getTraceState

String getTraceState()

 trace_state conveys information about request position in multiple distributed tracing graphs.
 It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header
 See also https://github.com/w3c/distributed-tracing for more details about this field.

string trace_state = 3;

Returns:: The traceState.

getTraceStateBytes

com.google.protobuf.ByteString getTraceStateBytes()

 trace_state conveys information about request position in multiple distributed tracing graphs.
 It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header
 See also https://github.com/w3c/distributed-tracing for more details about this field.

string trace_state = 3;

Returns:: The bytes for traceState.

getParentSpanId

com.google.protobuf.ByteString getParentSpanId()

 The `span_id` of this span's parent span. If this is a root span, then this
 field must be empty. The ID is an 8-byte array.

bytes parent_span_id = 4;

Returns:: The parentSpanId.

getName

String getName()

 A description of the span's operation.
 For example, the name can be a qualified method name or a file name
 and a line number where the operation is called. A best practice is to use
 the same display name at the same call point in an application.
 This makes it easier to correlate spans in different traces.
 This field is semantically required to be set to non-empty string.
 Empty value is equivalent to an unknown span name.
 This field is required.

string name = 5;

Returns:: The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 A description of the span's operation.
 For example, the name can be a qualified method name or a file name
 and a line number where the operation is called. A best practice is to use
 the same display name at the same call point in an application.
 This makes it easier to correlate spans in different traces.
 This field is semantically required to be set to non-empty string.
 Empty value is equivalent to an unknown span name.
 This field is required.

string name = 5;

Returns:: The bytes for name.

getKindValue

int getKindValue()

 Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `CLIENT` (caller)
 and `SERVER` (callee) to identify queueing latency associated with the span.

.opentelemetry.proto.trace.v1.Span.SpanKind kind = 6;

Returns:: The enum numeric value on the wire for kind.

getKind

Span.SpanKind getKind()

 Distinguishes between spans generated in a particular context. For example,
 two spans with the same name may be distinguished using `CLIENT` (caller)
 and `SERVER` (callee) to identify queueing latency associated with the span.

.opentelemetry.proto.trace.v1.Span.SpanKind kind = 6;

Returns:: The kind.

getStartTimeUnixNano

long getStartTimeUnixNano()

 start_time_unix_nano is the start time of the span. On the client side, this is the time
 kept by the local machine where the span execution starts. On the server side, this
 is the time when the server's application handler starts running.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
 This field is semantically required and it is expected that end_time >= start_time.

fixed64 start_time_unix_nano = 7;

Returns:: The startTimeUnixNano.

getEndTimeUnixNano

long getEndTimeUnixNano()

 end_time_unix_nano is the end time of the span. On the client side, this is the time
 kept by the local machine where the span execution ends. On the server side, this
 is the time when the server application handler stops running.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
 This field is semantically required and it is expected that end_time >= start_time.

fixed64 end_time_unix_nano = 8;

Returns:: The endTimeUnixNano.