Span.Builder (api 0.1.3 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>
    - - io.opencensus.proto.trace.Span.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SpanOrBuilder, Cloneable

Enclosing class:: Span

public static final class Span.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>
implements SpanOrBuilder

 A span represents a single operation within a trace. Spans can be
 nested to form a trace tree. Often, a trace contains a root span
 that describes the end-to-end latency, and one or more subspans for
 its sub-operations. A trace can also contain multiple root spans,
 or none at all. Spans do not need to be contiguous - there may be
 gaps or overlaps between spans in a trace.
 TODO(bdrutu): Add an example.

Protobuf type opencensus.proto.trace.Span

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Span.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Span`	`build()`
`Span`	`buildPartial()`
`Span.Builder`	`clear()`
`Span.Builder`	`clearAttributes()` A set of attributes on the span.
`Span.Builder`	`clearChildSpanCount()` An optional number of child spans that were generated while this span was active.
`Span.Builder`	`clearEndTime()` The end time of the span.
`Span.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Span.Builder`	`clearLinks()` The inclued links.
`Span.Builder`	`clearName()` A description of the span's operation.
`Span.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Span.Builder`	`clearParentSpanId()` The `span_id` of this span's parent span.
`Span.Builder`	`clearSameProcessAsParentSpan()` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`Span.Builder`	`clearSpanId()` A unique identifier for a span within a trace, assigned when the span is created.
`Span.Builder`	`clearStackTrace()` A stack trace captured at the start of the span.
`Span.Builder`	`clearStartTime()` The start time of the span.
`Span.Builder`	`clearStatus()` An optional final status for this span.
`Span.Builder`	`clearTimeEvents()` The included time events.
`Span.Builder`	`clearTraceId()` A unique identifier for a trace.
`Span.Builder`	`clone()`
`Span.Attributes`	`getAttributes()` A set of attributes on the span.
`Span.Attributes.Builder`	`getAttributesBuilder()` A set of attributes on the span.
`Span.AttributesOrBuilder`	`getAttributesOrBuilder()` A set of attributes on the span.
`com.google.protobuf.UInt32Value`	`getChildSpanCount()` An optional number of child spans that were generated while this span was active.
`com.google.protobuf.UInt32Value.Builder`	`getChildSpanCountBuilder()` An optional number of child spans that were generated while this span was active.
`com.google.protobuf.UInt32ValueOrBuilder`	`getChildSpanCountOrBuilder()` An optional number of child spans that were generated while this span was active.
`Span`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`com.google.protobuf.Timestamp`	`getEndTime()` The end time of the span.
`com.google.protobuf.Timestamp.Builder`	`getEndTimeBuilder()` The end time of the span.
`com.google.protobuf.TimestampOrBuilder`	`getEndTimeOrBuilder()` The end time of the span.
`Span.Links`	`getLinks()` The inclued links.
`Span.Links.Builder`	`getLinksBuilder()` The inclued links.
`Span.LinksOrBuilder`	`getLinksOrBuilder()` The inclued links.
`TruncatableString`	`getName()` A description of the span's operation.
`TruncatableString.Builder`	`getNameBuilder()` A description of the span's operation.
`TruncatableStringOrBuilder`	`getNameOrBuilder()` A description of the span's operation.
`com.google.protobuf.ByteString`	`getParentSpanId()` The `span_id` of this span's parent span.
`com.google.protobuf.BoolValue`	`getSameProcessAsParentSpan()` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`com.google.protobuf.BoolValue.Builder`	`getSameProcessAsParentSpanBuilder()` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`com.google.protobuf.BoolValueOrBuilder`	`getSameProcessAsParentSpanOrBuilder()` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`com.google.protobuf.ByteString`	`getSpanId()` A unique identifier for a span within a trace, assigned when the span is created.
`StackTrace`	`getStackTrace()` A stack trace captured at the start of the span.
`StackTrace.Builder`	`getStackTraceBuilder()` A stack trace captured at the start of the span.
`StackTraceOrBuilder`	`getStackTraceOrBuilder()` A stack trace captured at the start of the span.
`com.google.protobuf.Timestamp`	`getStartTime()` The start time of the span.
`com.google.protobuf.Timestamp.Builder`	`getStartTimeBuilder()` The start time of the span.
`com.google.protobuf.TimestampOrBuilder`	`getStartTimeOrBuilder()` The start time of the span.
`Status`	`getStatus()` An optional final status for this span.
`Status.Builder`	`getStatusBuilder()` An optional final status for this span.
`StatusOrBuilder`	`getStatusOrBuilder()` An optional final status for this span.
`Span.TimeEvents`	`getTimeEvents()` The included time events.
`Span.TimeEvents.Builder`	`getTimeEventsBuilder()` The included time events.
`Span.TimeEventsOrBuilder`	`getTimeEventsOrBuilder()` The included time events.
`com.google.protobuf.ByteString`	`getTraceId()` A unique identifier for a trace.
`boolean`	`hasAttributes()` A set of attributes on the span.
`boolean`	`hasChildSpanCount()` An optional number of child spans that were generated while this span was active.
`boolean`	`hasEndTime()` The end time of the span.
`boolean`	`hasLinks()` The inclued links.
`boolean`	`hasName()` A description of the span's operation.
`boolean`	`hasSameProcessAsParentSpan()` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`boolean`	`hasStackTrace()` A stack trace captured at the start of the span.
`boolean`	`hasStartTime()` The start time of the span.
`boolean`	`hasStatus()` An optional final status for this span.
`boolean`	`hasTimeEvents()` The included time events.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Span.Builder`	`mergeAttributes(Span.Attributes value)` A set of attributes on the span.
`Span.Builder`	`mergeChildSpanCount(com.google.protobuf.UInt32Value value)` An optional number of child spans that were generated while this span was active.
`Span.Builder`	`mergeEndTime(com.google.protobuf.Timestamp value)` The end time of the span.
`Span.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Span.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Span.Builder`	`mergeFrom(Span other)`
`Span.Builder`	`mergeLinks(Span.Links value)` The inclued links.
`Span.Builder`	`mergeName(TruncatableString value)` A description of the span's operation.
`Span.Builder`	`mergeSameProcessAsParentSpan(com.google.protobuf.BoolValue value)` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`Span.Builder`	`mergeStackTrace(StackTrace value)` A stack trace captured at the start of the span.
`Span.Builder`	`mergeStartTime(com.google.protobuf.Timestamp value)` The start time of the span.
`Span.Builder`	`mergeStatus(Status value)` An optional final status for this span.
`Span.Builder`	`mergeTimeEvents(Span.TimeEvents value)` The included time events.
`Span.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Span.Builder`	`setAttributes(Span.Attributes.Builder builderForValue)` A set of attributes on the span.
`Span.Builder`	`setAttributes(Span.Attributes value)` A set of attributes on the span.
`Span.Builder`	`setChildSpanCount(com.google.protobuf.UInt32Value.Builder builderForValue)` An optional number of child spans that were generated while this span was active.
`Span.Builder`	`setChildSpanCount(com.google.protobuf.UInt32Value value)` An optional number of child spans that were generated while this span was active.
`Span.Builder`	`setEndTime(com.google.protobuf.Timestamp.Builder builderForValue)` The end time of the span.
`Span.Builder`	`setEndTime(com.google.protobuf.Timestamp value)` The end time of the span.
`Span.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Span.Builder`	`setLinks(Span.Links.Builder builderForValue)` The inclued links.
`Span.Builder`	`setLinks(Span.Links value)` The inclued links.
`Span.Builder`	`setName(TruncatableString.Builder builderForValue)` A description of the span's operation.
`Span.Builder`	`setName(TruncatableString value)` A description of the span's operation.
`Span.Builder`	`setParentSpanId(com.google.protobuf.ByteString value)` The `span_id` of this span's parent span.
`Span.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Span.Builder`	`setSameProcessAsParentSpan(com.google.protobuf.BoolValue.Builder builderForValue)` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`Span.Builder`	`setSameProcessAsParentSpan(com.google.protobuf.BoolValue value)` A highly recommended but not required flag that identifies when a trace crosses a process boundary.
`Span.Builder`	`setSpanId(com.google.protobuf.ByteString value)` A unique identifier for a span within a trace, assigned when the span is created.
`Span.Builder`	`setStackTrace(StackTrace.Builder builderForValue)` A stack trace captured at the start of the span.
`Span.Builder`	`setStackTrace(StackTrace value)` A stack trace captured at the start of the span.
`Span.Builder`	`setStartTime(com.google.protobuf.Timestamp.Builder builderForValue)` The start time of the span.
`Span.Builder`	`setStartTime(com.google.protobuf.Timestamp value)` The start time of the span.
`Span.Builder`	`setStatus(Status.Builder builderForValue)` An optional final status for this span.
`Span.Builder`	`setStatus(Status value)` An optional final status for this span.
`Span.Builder`	`setTimeEvents(Span.TimeEvents.Builder builderForValue)` The included time events.
`Span.Builder`	`setTimeEvents(Span.TimeEvents value)` The included time events.
`Span.Builder`	`setTraceId(com.google.protobuf.ByteString value)` A unique identifier for a trace.
`Span.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

clear
```
public Span.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

getDefaultInstanceForType
```
public Span getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Span build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Span buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public Span.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

setField

public Span.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                             Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

clearField
```
public Span.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

clearOneof
```
public Span.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

setRepeatedField

public Span.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     int index,
                                     Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

addRepeatedField

public Span.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

mergeFrom
```
public Span.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Span.Builder>

mergeFrom

public Span.Builder mergeFrom(Span other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Span.Builder>

mergeFrom
```
public Span.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Span.Builder>

Throws:

IOException

getTraceId

public 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.
 This field is required.

bytes trace_id = 1;

Specified by:: getTraceId in interface SpanOrBuilder

setTraceId

public Span.Builder setTraceId(com.google.protobuf.ByteString value)

 A unique identifier for a trace. All spans from the same trace share
 the same `trace_id`. The ID is a 16-byte array.
 This field is required.

bytes trace_id = 1;

clearTraceId

public Span.Builder clearTraceId()

 A unique identifier for a trace. All spans from the same trace share
 the same `trace_id`. The ID is a 16-byte array.
 This field is required.

bytes trace_id = 1;

getSpanId

public 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.
 This field is required.

bytes span_id = 2;

Specified by:: getSpanId in interface SpanOrBuilder

setSpanId

public Span.Builder setSpanId(com.google.protobuf.ByteString value)

 A unique identifier for a span within a trace, assigned when the span
 is created. The ID is an 8-byte array.
 This field is required.

bytes span_id = 2;

clearSpanId

public Span.Builder clearSpanId()

 A unique identifier for a span within a trace, assigned when the span
 is created. The ID is an 8-byte array.
 This field is required.

bytes span_id = 2;

getParentSpanId

public 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 = 3;

Specified by:: getParentSpanId in interface SpanOrBuilder

setParentSpanId

public Span.Builder setParentSpanId(com.google.protobuf.ByteString value)

 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 = 3;

clearParentSpanId

public Span.Builder clearParentSpanId()

 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 = 3;

hasName

public boolean hasName()

 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

Specified by:: hasName in interface SpanOrBuilder

getName

public TruncatableString 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

Specified by:: getName in interface SpanOrBuilder

setName

public Span.Builder setName(TruncatableString value)

 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

setName

public Span.Builder setName(TruncatableString.Builder builderForValue)

 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

mergeName

public Span.Builder mergeName(TruncatableString value)

 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

clearName

public Span.Builder clearName()

 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

getNameBuilder

public TruncatableString.Builder getNameBuilder()

 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

getNameOrBuilder

public TruncatableStringOrBuilder getNameOrBuilder()

 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 required.

.opencensus.proto.trace.TruncatableString name = 4;

Specified by:: getNameOrBuilder in interface SpanOrBuilder

hasStartTime

public boolean hasStartTime()

 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.

.google.protobuf.Timestamp start_time = 5;

Specified by:: hasStartTime in interface SpanOrBuilder

getStartTime

public com.google.protobuf.Timestamp getStartTime()

 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.

.google.protobuf.Timestamp start_time = 5;

Specified by:: getStartTime in interface SpanOrBuilder

setStartTime

public Span.Builder setStartTime(com.google.protobuf.Timestamp value)

 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.

.google.protobuf.Timestamp start_time = 5;

setStartTime

public Span.Builder setStartTime(com.google.protobuf.Timestamp.Builder builderForValue)

 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.

.google.protobuf.Timestamp start_time = 5;

mergeStartTime

public Span.Builder mergeStartTime(com.google.protobuf.Timestamp value)

 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.

.google.protobuf.Timestamp start_time = 5;

clearStartTime

public Span.Builder clearStartTime()

 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.

.google.protobuf.Timestamp start_time = 5;

getStartTimeBuilder

public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()

 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.

.google.protobuf.Timestamp start_time = 5;

getStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 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.

.google.protobuf.Timestamp start_time = 5;

Specified by:: getStartTimeOrBuilder in interface SpanOrBuilder