SpanObject.Builder (apm-network 9.1.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<SpanObject.Builder>
    - - org.apache.skywalking.apm.network.language.agent.v3.SpanObject.Builder

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

Enclosing class:: SpanObject

public static final class SpanObject.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SpanObject.Builder>
implements SpanObjectOrBuilder

 Span represents a execution unit in the system, with duration and many other attributes.
 Span could be a method, a RPC, MQ message produce or consume.
 In the practice, the span should be added when it is really necessary, to avoid payload overhead.
 We recommend to creating spans in across process(client/server of RPC/MQ) and across thread cases only.

Protobuf type skywalking.v3.SpanObject

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SpanObject.Builder`	`addAllLogs(Iterable<? extends Log> values)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`addAllRefs(Iterable<? extends SegmentReference> values)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`addAllTags(Iterable<? extends KeyStringValuePair> values)` String key, String value pair.
`SpanObject.Builder`	`addLogs(int index, Log.Builder builderForValue)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`addLogs(int index, Log value)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`addLogs(Log.Builder builderForValue)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`addLogs(Log value)` String key, String value pair with an accurate timestamp.
`Log.Builder`	`addLogsBuilder()` String key, String value pair with an accurate timestamp.
`Log.Builder`	`addLogsBuilder(int index)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`addRefs(int index, SegmentReference.Builder builderForValue)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`addRefs(int index, SegmentReference value)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`addRefs(SegmentReference.Builder builderForValue)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`addRefs(SegmentReference value)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SegmentReference.Builder`	`addRefsBuilder()` <Optional> In the across thread and across process, these references targeting the parent segments.
`SegmentReference.Builder`	`addRefsBuilder(int index)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SpanObject.Builder`	`addTags(int index, KeyStringValuePair.Builder builderForValue)` String key, String value pair.
`SpanObject.Builder`	`addTags(int index, KeyStringValuePair value)` String key, String value pair.
`SpanObject.Builder`	`addTags(KeyStringValuePair.Builder builderForValue)` String key, String value pair.
`SpanObject.Builder`	`addTags(KeyStringValuePair value)` String key, String value pair.
`KeyStringValuePair.Builder`	`addTagsBuilder()` String key, String value pair.
`KeyStringValuePair.Builder`	`addTagsBuilder(int index)` String key, String value pair.
`SpanObject`	`build()`
`SpanObject`	`buildPartial()`
`SpanObject.Builder`	`clear()`
`SpanObject.Builder`	`clearComponentId()` Component id is a predefinited number id in the SkyWalking.
`SpanObject.Builder`	`clearEndTime()` End timestamp in milliseconds of this span, measured between the current time and midnight, January 1, 1970 UTC.
`SpanObject.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`SpanObject.Builder`	`clearIsError()` The status of the span.
`SpanObject.Builder`	`clearLogs()` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`SpanObject.Builder`	`clearOperationName()` A logic name represents this span.
`SpanObject.Builder`	`clearParentSpanId()` The number id of the parent span in the whole segment.
`SpanObject.Builder`	`clearPeer()` Remote address of the peer in RPC/MQ case.
`SpanObject.Builder`	`clearRefs()` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`clearSkipAnalysis()` Force the backend don't do analysis, if the value is TRUE.
`SpanObject.Builder`	`clearSpanId()` The number id of the span.
`SpanObject.Builder`	`clearSpanLayer()` Span layer represent the component tech stack, related to the network tech.
`SpanObject.Builder`	`clearSpanType()` Span type represents the role in the RPC context.
`SpanObject.Builder`	`clearStartTime()` Start timestamp in milliseconds of this span, measured between the current time and midnight, January 1, 1970 UTC.
`SpanObject.Builder`	`clearTags()` String key, String value pair.
`SpanObject.Builder`	`clone()`
`int`	`getComponentId()` Component id is a predefinited number id in the SkyWalking.
`SpanObject`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`long`	`getEndTime()` End timestamp in milliseconds of this span, measured between the current time and midnight, January 1, 1970 UTC.
`boolean`	`getIsError()` The status of the span.
`Log`	`getLogs(int index)` String key, String value pair with an accurate timestamp.
`Log.Builder`	`getLogsBuilder(int index)` String key, String value pair with an accurate timestamp.
`List<Log.Builder>`	`getLogsBuilderList()` String key, String value pair with an accurate timestamp.
`int`	`getLogsCount()` String key, String value pair with an accurate timestamp.
`List<Log>`	`getLogsList()` String key, String value pair with an accurate timestamp.
`LogOrBuilder`	`getLogsOrBuilder(int index)` String key, String value pair with an accurate timestamp.
`List<? extends LogOrBuilder>`	`getLogsOrBuilderList()` String key, String value pair with an accurate timestamp.
`String`	`getOperationName()` A logic name represents this span.
`com.google.protobuf.ByteString`	`getOperationNameBytes()` A logic name represents this span.
`int`	`getParentSpanId()` The number id of the parent span in the whole segment.
`String`	`getPeer()` Remote address of the peer in RPC/MQ case.
`com.google.protobuf.ByteString`	`getPeerBytes()` Remote address of the peer in RPC/MQ case.
`SegmentReference`	`getRefs(int index)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SegmentReference.Builder`	`getRefsBuilder(int index)` <Optional> In the across thread and across process, these references targeting the parent segments.
`List<SegmentReference.Builder>`	`getRefsBuilderList()` <Optional> In the across thread and across process, these references targeting the parent segments.
`int`	`getRefsCount()` <Optional> In the across thread and across process, these references targeting the parent segments.
`List<SegmentReference>`	`getRefsList()` <Optional> In the across thread and across process, these references targeting the parent segments.
`SegmentReferenceOrBuilder`	`getRefsOrBuilder(int index)` <Optional> In the across thread and across process, these references targeting the parent segments.
`List<? extends SegmentReferenceOrBuilder>`	`getRefsOrBuilderList()` <Optional> In the across thread and across process, these references targeting the parent segments.
`boolean`	`getSkipAnalysis()` Force the backend don't do analysis, if the value is TRUE.
`int`	`getSpanId()` The number id of the span.
`SpanLayer`	`getSpanLayer()` Span layer represent the component tech stack, related to the network tech.
`int`	`getSpanLayerValue()` Span layer represent the component tech stack, related to the network tech.
`SpanType`	`getSpanType()` Span type represents the role in the RPC context.
`int`	`getSpanTypeValue()` Span type represents the role in the RPC context.
`long`	`getStartTime()` Start timestamp in milliseconds of this span, measured between the current time and midnight, January 1, 1970 UTC.
`KeyStringValuePair`	`getTags(int index)` String key, String value pair.
`KeyStringValuePair.Builder`	`getTagsBuilder(int index)` String key, String value pair.
`List<KeyStringValuePair.Builder>`	`getTagsBuilderList()` String key, String value pair.
`int`	`getTagsCount()` String key, String value pair.
`List<KeyStringValuePair>`	`getTagsList()` String key, String value pair.
`KeyStringValuePairOrBuilder`	`getTagsOrBuilder(int index)` String key, String value pair.
`List<? extends KeyStringValuePairOrBuilder>`	`getTagsOrBuilderList()` String key, String value pair.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SpanObject.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SpanObject.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SpanObject.Builder`	`mergeFrom(SpanObject other)`
`SpanObject.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SpanObject.Builder`	`removeLogs(int index)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`removeRefs(int index)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`removeTags(int index)` String key, String value pair.
`SpanObject.Builder`	`setComponentId(int value)` Component id is a predefinited number id in the SkyWalking.
`SpanObject.Builder`	`setEndTime(long value)` End timestamp in milliseconds of this span, measured between the current time and midnight, January 1, 1970 UTC.
`SpanObject.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SpanObject.Builder`	`setIsError(boolean value)` The status of the span.
`SpanObject.Builder`	`setLogs(int index, Log.Builder builderForValue)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`setLogs(int index, Log value)` String key, String value pair with an accurate timestamp.
`SpanObject.Builder`	`setOperationName(String value)` A logic name represents this span.
`SpanObject.Builder`	`setOperationNameBytes(com.google.protobuf.ByteString value)` A logic name represents this span.
`SpanObject.Builder`	`setParentSpanId(int value)` The number id of the parent span in the whole segment.
`SpanObject.Builder`	`setPeer(String value)` Remote address of the peer in RPC/MQ case.
`SpanObject.Builder`	`setPeerBytes(com.google.protobuf.ByteString value)` Remote address of the peer in RPC/MQ case.
`SpanObject.Builder`	`setRefs(int index, SegmentReference.Builder builderForValue)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`setRefs(int index, SegmentReference value)` <Optional> In the across thread and across process, these references targeting the parent segments.
`SpanObject.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`SpanObject.Builder`	`setSkipAnalysis(boolean value)` Force the backend don't do analysis, if the value is TRUE.
`SpanObject.Builder`	`setSpanId(int value)` The number id of the span.
`SpanObject.Builder`	`setSpanLayer(SpanLayer value)` Span layer represent the component tech stack, related to the network tech.
`SpanObject.Builder`	`setSpanLayerValue(int value)` Span layer represent the component tech stack, related to the network tech.
`SpanObject.Builder`	`setSpanType(SpanType value)` Span type represents the role in the RPC context.
`SpanObject.Builder`	`setSpanTypeValue(int value)` Span type represents the role in the RPC context.
`SpanObject.Builder`	`setStartTime(long value)` Start timestamp in milliseconds of this span, measured between the current time and midnight, January 1, 1970 UTC.
`SpanObject.Builder`	`setTags(int index, KeyStringValuePair.Builder builderForValue)` String key, String value pair.
`SpanObject.Builder`	`setTags(int index, KeyStringValuePair value)` String key, String value pair.
`SpanObject.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<SpanObject.Builder>

clear
```
public SpanObject.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<SpanObject.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<SpanObject.Builder>

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

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

Specified by:

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

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

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

Specified by:

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

clone
```
public SpanObject.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<SpanObject.Builder>

setField

public SpanObject.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<SpanObject.Builder>

clearField
```
public SpanObject.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<SpanObject.Builder>

clearOneof
```
public SpanObject.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<SpanObject.Builder>

setRepeatedField

public SpanObject.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<SpanObject.Builder>

addRepeatedField

public SpanObject.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<SpanObject.Builder>

mergeFrom
```
public SpanObject.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<SpanObject.Builder>

mergeFrom

public SpanObject.Builder mergeFrom(SpanObject other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom
```
public SpanObject.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<SpanObject.Builder>

Throws:

IOException

getSpanId

public int getSpanId()

 The number id of the span. Should be unique in the whole segment.
 Starting at 0.

int32 spanId = 1;

Specified by:: getSpanId in interface SpanObjectOrBuilder
Returns:: The spanId.

setSpanId

public SpanObject.Builder setSpanId(int value)

 The number id of the span. Should be unique in the whole segment.
 Starting at 0.

int32 spanId = 1;

Parameters:: value - The spanId to set.
Returns:: This builder for chaining.

clearSpanId

public SpanObject.Builder clearSpanId()

 The number id of the span. Should be unique in the whole segment.
 Starting at 0.

int32 spanId = 1;

Returns:: This builder for chaining.

getParentSpanId

public int getParentSpanId()

 The number id of the parent span in the whole segment.
 -1 represents no parent span.
 Also, be known as the root/first span of the segment.

int32 parentSpanId = 2;

Specified by:: getParentSpanId in interface SpanObjectOrBuilder
Returns:: The parentSpanId.

setParentSpanId

public SpanObject.Builder setParentSpanId(int value)

 The number id of the parent span in the whole segment.
 -1 represents no parent span.
 Also, be known as the root/first span of the segment.

int32 parentSpanId = 2;

Parameters:: value - The parentSpanId to set.
Returns:: This builder for chaining.

clearParentSpanId

public SpanObject.Builder clearParentSpanId()

 The number id of the parent span in the whole segment.
 -1 represents no parent span.
 Also, be known as the root/first span of the segment.

int32 parentSpanId = 2;

Returns:: This builder for chaining.

getStartTime

public long getStartTime()

 Start timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.

int64 startTime = 3;

Specified by:: getStartTime in interface SpanObjectOrBuilder
Returns:: The startTime.

setStartTime

public SpanObject.Builder setStartTime(long value)

 Start timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.

int64 startTime = 3;

Parameters:: value - The startTime to set.
Returns:: This builder for chaining.

clearStartTime

public SpanObject.Builder clearStartTime()

 Start timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.

int64 startTime = 3;

Returns:: This builder for chaining.

getEndTime

public long getEndTime()

 End timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.

int64 endTime = 4;

Specified by:: getEndTime in interface SpanObjectOrBuilder
Returns:: The endTime.

setEndTime

public SpanObject.Builder setEndTime(long value)

 End timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.

int64 endTime = 4;

Parameters:: value - The endTime to set.
Returns:: This builder for chaining.

clearEndTime

public SpanObject.Builder clearEndTime()

 End timestamp in milliseconds of this span,
 measured between the current time and midnight, January 1, 1970 UTC.

int64 endTime = 4;

Returns:: This builder for chaining.

getRefsList

public List<SegmentReference> getRefsList()

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

Specified by:: getRefsList in interface SpanObjectOrBuilder

getRefsCount

public int getRefsCount()

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

Specified by:: getRefsCount in interface SpanObjectOrBuilder

getRefs

public SegmentReference getRefs(int index)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

Specified by:: getRefs in interface SpanObjectOrBuilder

setRefs

public SpanObject.Builder setRefs(int index,
                                  SegmentReference value)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

setRefs

public SpanObject.Builder setRefs(int index,
                                  SegmentReference.Builder builderForValue)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

addRefs

public SpanObject.Builder addRefs(SegmentReference value)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

addRefs

public SpanObject.Builder addRefs(int index,
                                  SegmentReference value)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

addRefs

public SpanObject.Builder addRefs(SegmentReference.Builder builderForValue)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

addRefs

public SpanObject.Builder addRefs(int index,
                                  SegmentReference.Builder builderForValue)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

addAllRefs

public SpanObject.Builder addAllRefs(Iterable<? extends SegmentReference> values)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

clearRefs

public SpanObject.Builder clearRefs()

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

removeRefs

public SpanObject.Builder removeRefs(int index)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

getRefsBuilder

public SegmentReference.Builder getRefsBuilder(int index)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

getRefsOrBuilder

public SegmentReferenceOrBuilder getRefsOrBuilder(int index)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

Specified by:: getRefsOrBuilder in interface SpanObjectOrBuilder

getRefsOrBuilderList

public List<? extends SegmentReferenceOrBuilder> getRefsOrBuilderList()

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

Specified by:: getRefsOrBuilderList in interface SpanObjectOrBuilder

addRefsBuilder

public SegmentReference.Builder addRefsBuilder()

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

addRefsBuilder

public SegmentReference.Builder addRefsBuilder(int index)

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

getRefsBuilderList

public List<SegmentReference.Builder> getRefsBuilderList()

 <Optional>
 In the across thread and across process, these references targeting the parent segments.
 The references usually have only one element, but in batch consumer case, such as in MQ or async batch process, it could be multiple.

repeated .skywalking.v3.SegmentReference refs = 5;

getOperationName

public String getOperationName()

 A logic name represents this span.
 We don't recommend to include the parameter, such as HTTP request parameters, as a part of the operation, especially this is the name of the entry span.
 All statistic for the endpoints are aggregated base on this name. Those parameters should be added in the tags if necessary.
 If in some cases, it have to be a part of the operation name,
 users should use the Group Parameterized Endpoints capability at the backend to get the meaningful metrics.
 Read https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/endpoint-grouping-rules.md

string operationName = 6;

Specified by:: getOperationName in interface SpanObjectOrBuilder
Returns:: The operationName.

getOperationNameBytes

public com.google.protobuf.ByteString getOperationNameBytes()

 A logic name represents this span.
 We don't recommend to include the parameter, such as HTTP request parameters, as a part of the operation, especially this is the name of the entry span.
 All statistic for the endpoints are aggregated base on this name. Those parameters should be added in the tags if necessary.
 If in some cases, it have to be a part of the operation name,
 users should use the Group Parameterized Endpoints capability at the backend to get the meaningful metrics.
 Read https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/endpoint-grouping-rules.md

string operationName = 6;

Specified by:: getOperationNameBytes in interface SpanObjectOrBuilder
Returns:: The bytes for operationName.

setOperationName

public SpanObject.Builder setOperationName(String value)

 A logic name represents this span.
 We don't recommend to include the parameter, such as HTTP request parameters, as a part of the operation, especially this is the name of the entry span.
 All statistic for the endpoints are aggregated base on this name. Those parameters should be added in the tags if necessary.
 If in some cases, it have to be a part of the operation name,
 users should use the Group Parameterized Endpoints capability at the backend to get the meaningful metrics.
 Read https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/endpoint-grouping-rules.md

string operationName = 6;

Parameters:: value - The operationName to set.
Returns:: This builder for chaining.

clearOperationName

public SpanObject.Builder clearOperationName()

 A logic name represents this span.
 We don't recommend to include the parameter, such as HTTP request parameters, as a part of the operation, especially this is the name of the entry span.
 All statistic for the endpoints are aggregated base on this name. Those parameters should be added in the tags if necessary.
 If in some cases, it have to be a part of the operation name,
 users should use the Group Parameterized Endpoints capability at the backend to get the meaningful metrics.
 Read https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/endpoint-grouping-rules.md

string operationName = 6;

Returns:: This builder for chaining.

setOperationNameBytes

public SpanObject.Builder setOperationNameBytes(com.google.protobuf.ByteString value)

 A logic name represents this span.
 We don't recommend to include the parameter, such as HTTP request parameters, as a part of the operation, especially this is the name of the entry span.
 All statistic for the endpoints are aggregated base on this name. Those parameters should be added in the tags if necessary.
 If in some cases, it have to be a part of the operation name,
 users should use the Group Parameterized Endpoints capability at the backend to get the meaningful metrics.
 Read https://github.com/apache/skywalking/blob/master/docs/en/setup/backend/endpoint-grouping-rules.md

string operationName = 6;

Parameters:: value - The bytes for operationName to set.
Returns:: This builder for chaining.

getPeer

public String getPeer()

 Remote address of the peer in RPC/MQ case.
 This is required when spanType = Exit, as it is a part of the SkyWalking STAM(Streaming Topology Analysis Method).
 For more details, read https://wu-sheng.github.io/STAM/

string peer = 7;

Specified by:: getPeer in interface SpanObjectOrBuilder
Returns:: The peer.

getPeerBytes

public com.google.protobuf.ByteString getPeerBytes()

 Remote address of the peer in RPC/MQ case.
 This is required when spanType = Exit, as it is a part of the SkyWalking STAM(Streaming Topology Analysis Method).
 For more details, read https://wu-sheng.github.io/STAM/

string peer = 7;

Specified by:: getPeerBytes in interface SpanObjectOrBuilder
Returns:: The bytes for peer.

setPeer

public SpanObject.Builder setPeer(String value)

 Remote address of the peer in RPC/MQ case.
 This is required when spanType = Exit, as it is a part of the SkyWalking STAM(Streaming Topology Analysis Method).
 For more details, read https://wu-sheng.github.io/STAM/

string peer = 7;

Parameters:: value - The peer to set.
Returns:: This builder for chaining.

clearPeer

public SpanObject.Builder clearPeer()

 Remote address of the peer in RPC/MQ case.
 This is required when spanType = Exit, as it is a part of the SkyWalking STAM(Streaming Topology Analysis Method).
 For more details, read https://wu-sheng.github.io/STAM/

string peer = 7;

Returns:: This builder for chaining.

setPeerBytes

public SpanObject.Builder setPeerBytes(com.google.protobuf.ByteString value)

 Remote address of the peer in RPC/MQ case.
 This is required when spanType = Exit, as it is a part of the SkyWalking STAM(Streaming Topology Analysis Method).
 For more details, read https://wu-sheng.github.io/STAM/

string peer = 7;

Parameters:: value - The bytes for peer to set.
Returns:: This builder for chaining.

getSpanTypeValue
```
public int getSpanTypeValue()
```
```
 Span type represents the role in the RPC context.
 
```
.skywalking.v3.SpanType spanType = 8;
Specified by:

getSpanTypeValue in interface SpanObjectOrBuilder

Returns:

The enum numeric value on the wire for spanType.

setSpanTypeValue
```
public SpanObject.Builder setSpanTypeValue(int value)
```
```
 Span type represents the role in the RPC context.
 
```
.skywalking.v3.SpanType spanType = 8;
Parameters:

value - The enum numeric value on the wire for spanType to set.

Returns:

This builder for chaining.

getSpanType
```
public SpanType getSpanType()
```
```
 Span type represents the role in the RPC context.
 
```
.skywalking.v3.SpanType spanType = 8;
Specified by:

getSpanType in interface SpanObjectOrBuilder

Returns:

The spanType.

setSpanType
```
public SpanObject.Builder setSpanType(SpanType value)
```
```
 Span type represents the role in the RPC context.
 
```
.skywalking.v3.SpanType spanType = 8;
Parameters:

value - The spanType to set.

Returns:

This builder for chaining.

clearSpanType

public SpanObject.Builder clearSpanType()

 Span type represents the role in the RPC context.

.skywalking.v3.SpanType spanType = 8;

Returns:: This builder for chaining.

getSpanLayerValue
```
public int getSpanLayerValue()
```
```
 Span layer represent the component tech stack, related to the network tech.
 
```
.skywalking.v3.SpanLayer spanLayer = 9;
Specified by:

getSpanLayerValue in interface SpanObjectOrBuilder

Returns:

The enum numeric value on the wire for spanLayer.

setSpanLayerValue
```
public SpanObject.Builder setSpanLayerValue(int value)
```
```
 Span layer represent the component tech stack, related to the network tech.
 
```
.skywalking.v3.SpanLayer spanLayer = 9;
Parameters:

value - The enum numeric value on the wire for spanLayer to set.

Returns:

This builder for chaining.

getSpanLayer
```
public SpanLayer getSpanLayer()
```
```
 Span layer represent the component tech stack, related to the network tech.
 
```
.skywalking.v3.SpanLayer spanLayer = 9;
Specified by:

getSpanLayer in interface SpanObjectOrBuilder

Returns:

The spanLayer.

setSpanLayer

public SpanObject.Builder setSpanLayer(SpanLayer value)

 Span layer represent the component tech stack, related to the network tech.

.skywalking.v3.SpanLayer spanLayer = 9;

Parameters:: value - The spanLayer to set.
Returns:: This builder for chaining.

clearSpanLayer

public SpanObject.Builder clearSpanLayer()

 Span layer represent the component tech stack, related to the network tech.

.skywalking.v3.SpanLayer spanLayer = 9;

Returns:: This builder for chaining.

getComponentId

public int getComponentId()

 Component id is a predefinited number id in the SkyWalking.
 It represents the framework, tech stack used by this tracked span, such as Spring.
 All IDs are defined in the https://github.com/apache/skywalking/blob/master/oap-server/server-bootstrap/src/main/resources/component-libraries.yml
 Send a pull request if you want to add languages, components or mapping defintions,
 all public components could be accepted.
 Follow this doc for more details, https://github.com/apache/skywalking/blob/master/docs/en/guides/Component-library-settings.md

int32 componentId = 10;

Specified by:: getComponentId in interface SpanObjectOrBuilder
Returns:: The componentId.

setComponentId

public SpanObject.Builder setComponentId(int value)

 Component id is a predefinited number id in the SkyWalking.
 It represents the framework, tech stack used by this tracked span, such as Spring.
 All IDs are defined in the https://github.com/apache/skywalking/blob/master/oap-server/server-bootstrap/src/main/resources/component-libraries.yml
 Send a pull request if you want to add languages, components or mapping defintions,
 all public components could be accepted.
 Follow this doc for more details, https://github.com/apache/skywalking/blob/master/docs/en/guides/Component-library-settings.md

int32 componentId = 10;

Parameters:: value - The componentId to set.
Returns:: This builder for chaining.

clearComponentId

public SpanObject.Builder clearComponentId()

 Component id is a predefinited number id in the SkyWalking.
 It represents the framework, tech stack used by this tracked span, such as Spring.
 All IDs are defined in the https://github.com/apache/skywalking/blob/master/oap-server/server-bootstrap/src/main/resources/component-libraries.yml
 Send a pull request if you want to add languages, components or mapping defintions,
 all public components could be accepted.
 Follow this doc for more details, https://github.com/apache/skywalking/blob/master/docs/en/guides/Component-library-settings.md

int32 componentId = 10;

Returns:: This builder for chaining.

getIsError

public boolean getIsError()

 The status of the span. False means the tracked execution ends in the unexpected status.
 This affects the successful rate statistic in the backend.
 Exception or error code happened in the tracked process doesn't mean isError == true, the implementations of agent plugin and tracing SDK make the final decision.

bool isError = 11;

Specified by:: getIsError in interface SpanObjectOrBuilder
Returns:: The isError.

setIsError

public SpanObject.Builder setIsError(boolean value)

 The status of the span. False means the tracked execution ends in the unexpected status.
 This affects the successful rate statistic in the backend.
 Exception or error code happened in the tracked process doesn't mean isError == true, the implementations of agent plugin and tracing SDK make the final decision.

bool isError = 11;

Parameters:: value - The isError to set.
Returns:: This builder for chaining.

clearIsError

public SpanObject.Builder clearIsError()

 The status of the span. False means the tracked execution ends in the unexpected status.
 This affects the successful rate statistic in the backend.
 Exception or error code happened in the tracked process doesn't mean isError == true, the implementations of agent plugin and tracing SDK make the final decision.

bool isError = 11;

Returns:: This builder for chaining.

getTagsList

public List<KeyStringValuePair> getTagsList()

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

Specified by:: getTagsList in interface SpanObjectOrBuilder

getTagsCount

public int getTagsCount()

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

Specified by:: getTagsCount in interface SpanObjectOrBuilder

getTags

public KeyStringValuePair getTags(int index)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

Specified by:: getTags in interface SpanObjectOrBuilder

setTags

public SpanObject.Builder setTags(int index,
                                  KeyStringValuePair value)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

setTags

public SpanObject.Builder setTags(int index,
                                  KeyStringValuePair.Builder builderForValue)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

addTags

public SpanObject.Builder addTags(KeyStringValuePair value)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

addTags

public SpanObject.Builder addTags(int index,
                                  KeyStringValuePair value)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

addTags

public SpanObject.Builder addTags(KeyStringValuePair.Builder builderForValue)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

addTags

public SpanObject.Builder addTags(int index,
                                  KeyStringValuePair.Builder builderForValue)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

addAllTags

public SpanObject.Builder addAllTags(Iterable<? extends KeyStringValuePair> values)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

clearTags

public SpanObject.Builder clearTags()

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

removeTags

public SpanObject.Builder removeTags(int index)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

getTagsBuilder

public KeyStringValuePair.Builder getTagsBuilder(int index)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

getTagsOrBuilder

public KeyStringValuePairOrBuilder getTagsOrBuilder(int index)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

Specified by:: getTagsOrBuilder in interface SpanObjectOrBuilder

getTagsOrBuilderList

public List<? extends KeyStringValuePairOrBuilder> getTagsOrBuilderList()

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

Specified by:: getTagsOrBuilderList in interface SpanObjectOrBuilder

addTagsBuilder

public KeyStringValuePair.Builder addTagsBuilder()

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

addTagsBuilder

public KeyStringValuePair.Builder addTagsBuilder(int index)

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;

getTagsBuilderList

public List<KeyStringValuePair.Builder> getTagsBuilderList()

 String key, String value pair.
 Tags provides more informance, includes parameters.
 In the OAP backend analysis, some special tag or tag combination could provide other advanced features.
 https://github.com/apache/skywalking/blob/master/docs/en/guides/Java-Plugin-Development-Guide.md#special-span-tags

repeated .skywalking.v3.KeyStringValuePair tags = 12;