public static final class SegmentObject.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder> implements SegmentObjectOrBuilder
The segment is a collection of spans. It includes all collected spans in a simple one request context, such as a HTTP request process. We recommend the agent/SDK report all tracked data of one request once for all, such as, typically, such as in Java, one segment represent all tracked operations(spans) of one request context in the same thread. At the same time, in some language there is not a clear concept like golang, it could represent all tracked operations of one request context.Protobuf type
skywalking.v3.SegmentObject| Modifier and Type | Method and Description |
|---|---|
SegmentObject.Builder |
addAllSpans(Iterable<? extends SpanObject> values)
Span collections included in this segment.
|
SegmentObject.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SegmentObject.Builder |
addSpans(int index,
SpanObject.Builder builderForValue)
Span collections included in this segment.
|
SegmentObject.Builder |
addSpans(int index,
SpanObject value)
Span collections included in this segment.
|
SegmentObject.Builder |
addSpans(SpanObject.Builder builderForValue)
Span collections included in this segment.
|
SegmentObject.Builder |
addSpans(SpanObject value)
Span collections included in this segment.
|
SpanObject.Builder |
addSpansBuilder()
Span collections included in this segment.
|
SpanObject.Builder |
addSpansBuilder(int index)
Span collections included in this segment.
|
SegmentObject |
build() |
SegmentObject |
buildPartial() |
SegmentObject.Builder |
clear() |
SegmentObject.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
SegmentObject.Builder |
clearIsSizeLimited()
Whether the segment includes all tracked spans.
|
SegmentObject.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
SegmentObject.Builder |
clearService()
**Service**.
|
SegmentObject.Builder |
clearServiceInstance()
**Service Instance**.
|
SegmentObject.Builder |
clearSpans()
Span collections included in this segment.
|
SegmentObject.Builder |
clearTraceId()
A string id represents the whole trace.
|
SegmentObject.Builder |
clearTraceSegmentId()
A unique id represents this segment.
|
SegmentObject.Builder |
clone() |
SegmentObject |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
boolean |
getIsSizeLimited()
Whether the segment includes all tracked spans.
|
String |
getService()
**Service**.
|
com.google.protobuf.ByteString |
getServiceBytes()
**Service**.
|
String |
getServiceInstance()
**Service Instance**.
|
com.google.protobuf.ByteString |
getServiceInstanceBytes()
**Service Instance**.
|
SpanObject |
getSpans(int index)
Span collections included in this segment.
|
SpanObject.Builder |
getSpansBuilder(int index)
Span collections included in this segment.
|
List<SpanObject.Builder> |
getSpansBuilderList()
Span collections included in this segment.
|
int |
getSpansCount()
Span collections included in this segment.
|
List<SpanObject> |
getSpansList()
Span collections included in this segment.
|
SpanObjectOrBuilder |
getSpansOrBuilder(int index)
Span collections included in this segment.
|
List<? extends SpanObjectOrBuilder> |
getSpansOrBuilderList()
Span collections included in this segment.
|
String |
getTraceId()
A string id represents the whole trace.
|
com.google.protobuf.ByteString |
getTraceIdBytes()
A string id represents the whole trace.
|
String |
getTraceSegmentId()
A unique id represents this segment.
|
com.google.protobuf.ByteString |
getTraceSegmentIdBytes()
A unique id represents this segment.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
SegmentObject.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
SegmentObject.Builder |
mergeFrom(com.google.protobuf.Message other) |
SegmentObject.Builder |
mergeFrom(SegmentObject other) |
SegmentObject.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
SegmentObject.Builder |
removeSpans(int index)
Span collections included in this segment.
|
SegmentObject.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SegmentObject.Builder |
setIsSizeLimited(boolean value)
Whether the segment includes all tracked spans.
|
SegmentObject.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
SegmentObject.Builder |
setService(String value)
**Service**.
|
SegmentObject.Builder |
setServiceBytes(com.google.protobuf.ByteString value)
**Service**.
|
SegmentObject.Builder |
setServiceInstance(String value)
**Service Instance**.
|
SegmentObject.Builder |
setServiceInstanceBytes(com.google.protobuf.ByteString value)
**Service Instance**.
|
SegmentObject.Builder |
setSpans(int index,
SpanObject.Builder builderForValue)
Span collections included in this segment.
|
SegmentObject.Builder |
setSpans(int index,
SpanObject value)
Span collections included in this segment.
|
SegmentObject.Builder |
setTraceId(String value)
A string id represents the whole trace.
|
SegmentObject.Builder |
setTraceIdBytes(com.google.protobuf.ByteString value)
A string id represents the whole trace.
|
SegmentObject.Builder |
setTraceSegmentId(String value)
A unique id represents this segment.
|
SegmentObject.Builder |
setTraceSegmentIdBytes(com.google.protobuf.ByteString value)
A unique id represents this segment.
|
SegmentObject.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SegmentObject build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SegmentObject buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SegmentObject.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SegmentObject.Builder>public SegmentObject.Builder mergeFrom(SegmentObject other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public SegmentObject.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SegmentObject.Builder>IOExceptionpublic String getTraceId()
A string id represents the whole trace.
string traceId = 1;getTraceId in interface SegmentObjectOrBuilderpublic com.google.protobuf.ByteString getTraceIdBytes()
A string id represents the whole trace.
string traceId = 1;getTraceIdBytes in interface SegmentObjectOrBuilderpublic SegmentObject.Builder setTraceId(String value)
A string id represents the whole trace.
string traceId = 1;value - The traceId to set.public SegmentObject.Builder clearTraceId()
A string id represents the whole trace.
string traceId = 1;public SegmentObject.Builder setTraceIdBytes(com.google.protobuf.ByteString value)
A string id represents the whole trace.
string traceId = 1;value - The bytes for traceId to set.public String getTraceSegmentId()
A unique id represents this segment. Other segments could use this id to reference as a child segment.
string traceSegmentId = 2;getTraceSegmentId in interface SegmentObjectOrBuilderpublic com.google.protobuf.ByteString getTraceSegmentIdBytes()
A unique id represents this segment. Other segments could use this id to reference as a child segment.
string traceSegmentId = 2;getTraceSegmentIdBytes in interface SegmentObjectOrBuilderpublic SegmentObject.Builder setTraceSegmentId(String value)
A unique id represents this segment. Other segments could use this id to reference as a child segment.
string traceSegmentId = 2;value - The traceSegmentId to set.public SegmentObject.Builder clearTraceSegmentId()
A unique id represents this segment. Other segments could use this id to reference as a child segment.
string traceSegmentId = 2;public SegmentObject.Builder setTraceSegmentIdBytes(com.google.protobuf.ByteString value)
A unique id represents this segment. Other segments could use this id to reference as a child segment.
string traceSegmentId = 2;value - The bytes for traceSegmentId to set.public List<SpanObject> getSpansList()
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;getSpansList in interface SegmentObjectOrBuilderpublic int getSpansCount()
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;getSpansCount in interface SegmentObjectOrBuilderpublic SpanObject getSpans(int index)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;getSpans in interface SegmentObjectOrBuilderpublic SegmentObject.Builder setSpans(int index, SpanObject value)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder setSpans(int index, SpanObject.Builder builderForValue)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder addSpans(SpanObject value)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder addSpans(int index, SpanObject value)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder addSpans(SpanObject.Builder builderForValue)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder addSpans(int index, SpanObject.Builder builderForValue)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder addAllSpans(Iterable<? extends SpanObject> values)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder clearSpans()
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SegmentObject.Builder removeSpans(int index)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SpanObject.Builder getSpansBuilder(int index)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SpanObjectOrBuilder getSpansOrBuilder(int index)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;getSpansOrBuilder in interface SegmentObjectOrBuilderpublic List<? extends SpanObjectOrBuilder> getSpansOrBuilderList()
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;getSpansOrBuilderList in interface SegmentObjectOrBuilderpublic SpanObject.Builder addSpansBuilder()
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public SpanObject.Builder addSpansBuilder(int index)
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public List<SpanObject.Builder> getSpansBuilderList()
Span collections included in this segment.
repeated .skywalking.v3.SpanObject spans = 3;public String getService()
**Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests. The logic name represents the service. This would show as a separate node in the topology. The metrics analyzed from the spans, would be aggregated for this entity as the service level.
string service = 4;getService in interface SegmentObjectOrBuilderpublic com.google.protobuf.ByteString getServiceBytes()
**Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests. The logic name represents the service. This would show as a separate node in the topology. The metrics analyzed from the spans, would be aggregated for this entity as the service level.
string service = 4;getServiceBytes in interface SegmentObjectOrBuilderpublic SegmentObject.Builder setService(String value)
**Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests. The logic name represents the service. This would show as a separate node in the topology. The metrics analyzed from the spans, would be aggregated for this entity as the service level.
string service = 4;value - The service to set.public SegmentObject.Builder clearService()
**Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests. The logic name represents the service. This would show as a separate node in the topology. The metrics analyzed from the spans, would be aggregated for this entity as the service level.
string service = 4;public SegmentObject.Builder setServiceBytes(com.google.protobuf.ByteString value)
**Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests. The logic name represents the service. This would show as a separate node in the topology. The metrics analyzed from the spans, would be aggregated for this entity as the service level.
string service = 4;value - The bytes for service to set.public String getServiceInstance()
**Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process. The logic name represents the service instance. This would show as a separate node in the instance relationship. The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
string serviceInstance = 5;getServiceInstance in interface SegmentObjectOrBuilderpublic com.google.protobuf.ByteString getServiceInstanceBytes()
**Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process. The logic name represents the service instance. This would show as a separate node in the instance relationship. The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
string serviceInstance = 5;getServiceInstanceBytes in interface SegmentObjectOrBuilderpublic SegmentObject.Builder setServiceInstance(String value)
**Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process. The logic name represents the service instance. This would show as a separate node in the instance relationship. The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
string serviceInstance = 5;value - The serviceInstance to set.public SegmentObject.Builder clearServiceInstance()
**Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process. The logic name represents the service instance. This would show as a separate node in the instance relationship. The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
string serviceInstance = 5;public SegmentObject.Builder setServiceInstanceBytes(com.google.protobuf.ByteString value)
**Service Instance**. Each individual workload in the Service group is known as an instance. Like `pods` in Kubernetes, it doesn't need to be a single OS process, however, if you are using instrument agents, an instance is actually a real OS process. The logic name represents the service instance. This would show as a separate node in the instance relationship. The metrics analyzed from the spans, would be aggregated for this entity as the service instance level.
string serviceInstance = 5;value - The bytes for serviceInstance to set.public boolean getIsSizeLimited()
Whether the segment includes all tracked spans. In the production environment tracked, some tasks could include too many spans for one request context, such as a batch update for a cache, or an async job. The agent/SDK could optimize or ignore some tracked spans for better performance. In this case, the value should be flagged as TRUE.
bool isSizeLimited = 6;getIsSizeLimited in interface SegmentObjectOrBuilderpublic SegmentObject.Builder setIsSizeLimited(boolean value)
Whether the segment includes all tracked spans. In the production environment tracked, some tasks could include too many spans for one request context, such as a batch update for a cache, or an async job. The agent/SDK could optimize or ignore some tracked spans for better performance. In this case, the value should be flagged as TRUE.
bool isSizeLimited = 6;value - The isSizeLimited to set.public SegmentObject.Builder clearIsSizeLimited()
Whether the segment includes all tracked spans. In the production environment tracked, some tasks could include too many spans for one request context, such as a batch update for a cache, or an async job. The agent/SDK could optimize or ignore some tracked spans for better performance. In this case, the value should be flagged as TRUE.
bool isSizeLimited = 6;public final SegmentObject.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>public final SegmentObject.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentObject.Builder>Copyright © 2022 The Apache Software Foundation. All rights reserved.