SegmentReference.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<SegmentReference.Builder>
    - - org.apache.skywalking.apm.network.language.agent.v3.SegmentReference.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, SegmentReferenceOrBuilder

Enclosing class:

SegmentReference
```
public static final class SegmentReference.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SegmentReference.Builder>
implements SegmentReferenceOrBuilder
```
```
 Segment reference represents the link between two existing segment.
 
```
Protobuf type skywalking.v3.SegmentReference

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SegmentReference.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SegmentReference`	`build()`
`SegmentReference`	`buildPartial()`
`SegmentReference.Builder`	`clear()`
`SegmentReference.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`SegmentReference.Builder`	`clearNetworkAddressUsedAtPeer()` The network address, including ip/hostname and port, which is used in the client side.
`SegmentReference.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`SegmentReference.Builder`	`clearParentEndpoint()` The endpoint name of the parent segment.
`SegmentReference.Builder`	`clearParentService()` The service logic name of the parent segment.
`SegmentReference.Builder`	`clearParentServiceInstance()` The service logic name instance of the parent segment.
`SegmentReference.Builder`	`clearParentSpanId()` The span id in the parent trace segment.
`SegmentReference.Builder`	`clearParentTraceSegmentId()` Another segment id as the parent.
`SegmentReference.Builder`	`clearRefType()` Represent the reference type.
`SegmentReference.Builder`	`clearTraceId()` A string id represents the whole trace.
`SegmentReference.Builder`	`clone()`
`SegmentReference`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getNetworkAddressUsedAtPeer()` The network address, including ip/hostname and port, which is used in the client side.
`com.google.protobuf.ByteString`	`getNetworkAddressUsedAtPeerBytes()` The network address, including ip/hostname and port, which is used in the client side.
`String`	`getParentEndpoint()` The endpoint name of the parent segment.
`com.google.protobuf.ByteString`	`getParentEndpointBytes()` The endpoint name of the parent segment.
`String`	`getParentService()` The service logic name of the parent segment.
`com.google.protobuf.ByteString`	`getParentServiceBytes()` The service logic name of the parent segment.
`String`	`getParentServiceInstance()` The service logic name instance of the parent segment.
`com.google.protobuf.ByteString`	`getParentServiceInstanceBytes()` The service logic name instance of the parent segment.
`int`	`getParentSpanId()` The span id in the parent trace segment.
`String`	`getParentTraceSegmentId()` Another segment id as the parent.
`com.google.protobuf.ByteString`	`getParentTraceSegmentIdBytes()` Another segment id as the parent.
`RefType`	`getRefType()` Represent the reference type.
`int`	`getRefTypeValue()` Represent the reference type.
`String`	`getTraceId()` A string id represents the whole trace.
`com.google.protobuf.ByteString`	`getTraceIdBytes()` A string id represents the whole trace.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SegmentReference.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SegmentReference.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SegmentReference.Builder`	`mergeFrom(SegmentReference other)`
`SegmentReference.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SegmentReference.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SegmentReference.Builder`	`setNetworkAddressUsedAtPeer(String value)` The network address, including ip/hostname and port, which is used in the client side.
`SegmentReference.Builder`	`setNetworkAddressUsedAtPeerBytes(com.google.protobuf.ByteString value)` The network address, including ip/hostname and port, which is used in the client side.
`SegmentReference.Builder`	`setParentEndpoint(String value)` The endpoint name of the parent segment.
`SegmentReference.Builder`	`setParentEndpointBytes(com.google.protobuf.ByteString value)` The endpoint name of the parent segment.
`SegmentReference.Builder`	`setParentService(String value)` The service logic name of the parent segment.
`SegmentReference.Builder`	`setParentServiceBytes(com.google.protobuf.ByteString value)` The service logic name of the parent segment.
`SegmentReference.Builder`	`setParentServiceInstance(String value)` The service logic name instance of the parent segment.
`SegmentReference.Builder`	`setParentServiceInstanceBytes(com.google.protobuf.ByteString value)` The service logic name instance of the parent segment.
`SegmentReference.Builder`	`setParentSpanId(int value)` The span id in the parent trace segment.
`SegmentReference.Builder`	`setParentTraceSegmentId(String value)` Another segment id as the parent.
`SegmentReference.Builder`	`setParentTraceSegmentIdBytes(com.google.protobuf.ByteString value)` Another segment id as the parent.
`SegmentReference.Builder`	`setRefType(RefType value)` Represent the reference type.
`SegmentReference.Builder`	`setRefTypeValue(int value)` Represent the reference type.
`SegmentReference.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`SegmentReference.Builder`	`setTraceId(String value)` A string id represents the whole trace.
`SegmentReference.Builder`	`setTraceIdBytes(com.google.protobuf.ByteString value)` A string id represents the whole trace.
`SegmentReference.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<SegmentReference.Builder>

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

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

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

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

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

Specified by:

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

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

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

Specified by:

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

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

setField

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

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

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

setRepeatedField

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

addRepeatedField

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

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

mergeFrom

public SegmentReference.Builder mergeFrom(SegmentReference other)

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

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

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

Throws:

IOException

getRefTypeValue

public int getRefTypeValue()

 Represent the reference type. It could be across thread or across process.
 Across process means there is a downstream RPC call for this.
 Typically, refType == CrossProcess means SpanObject#spanType = entry.

.skywalking.v3.RefType refType = 1;

Specified by:: getRefTypeValue in interface SegmentReferenceOrBuilder
Returns:: The enum numeric value on the wire for refType.

setRefTypeValue

public SegmentReference.Builder setRefTypeValue(int value)

 Represent the reference type. It could be across thread or across process.
 Across process means there is a downstream RPC call for this.
 Typically, refType == CrossProcess means SpanObject#spanType = entry.

.skywalking.v3.RefType refType = 1;

Parameters:: value - The enum numeric value on the wire for refType to set.
Returns:: This builder for chaining.

getRefType

public RefType getRefType()

 Represent the reference type. It could be across thread or across process.
 Across process means there is a downstream RPC call for this.
 Typically, refType == CrossProcess means SpanObject#spanType = entry.

.skywalking.v3.RefType refType = 1;

Specified by:: getRefType in interface SegmentReferenceOrBuilder
Returns:: The refType.

setRefType

public SegmentReference.Builder setRefType(RefType value)

 Represent the reference type. It could be across thread or across process.
 Across process means there is a downstream RPC call for this.
 Typically, refType == CrossProcess means SpanObject#spanType = entry.

.skywalking.v3.RefType refType = 1;

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

clearRefType

public SegmentReference.Builder clearRefType()

 Represent the reference type. It could be across thread or across process.
 Across process means there is a downstream RPC call for this.
 Typically, refType == CrossProcess means SpanObject#spanType = entry.

.skywalking.v3.RefType refType = 1;

Returns:: This builder for chaining.

getTraceId
```
public String getTraceId()
```
```
 A string id represents the whole trace.
 
```
string traceId = 2;
Specified by:

getTraceId in interface SegmentReferenceOrBuilder

Returns:

The traceId.

getTraceIdBytes
```
public com.google.protobuf.ByteString getTraceIdBytes()
```
```
 A string id represents the whole trace.
 
```
string traceId = 2;
Specified by:

getTraceIdBytes in interface SegmentReferenceOrBuilder

Returns:

The bytes for traceId.

setTraceId

public SegmentReference.Builder setTraceId(String value)

 A string id represents the whole trace.

string traceId = 2;

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

clearTraceId

public SegmentReference.Builder clearTraceId()

 A string id represents the whole trace.

string traceId = 2;

Returns:: This builder for chaining.

setTraceIdBytes

public SegmentReference.Builder setTraceIdBytes(com.google.protobuf.ByteString value)

 A string id represents the whole trace.

string traceId = 2;

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

getParentTraceSegmentId
```
public String getParentTraceSegmentId()
```
```
 Another segment id as the parent.
 
```
string parentTraceSegmentId = 3;
Specified by:

getParentTraceSegmentId in interface SegmentReferenceOrBuilder

Returns:

The parentTraceSegmentId.

getParentTraceSegmentIdBytes
```
public com.google.protobuf.ByteString getParentTraceSegmentIdBytes()
```
```
 Another segment id as the parent.
 
```
string parentTraceSegmentId = 3;
Specified by:

getParentTraceSegmentIdBytes in interface SegmentReferenceOrBuilder

Returns:

The bytes for parentTraceSegmentId.

setParentTraceSegmentId
```
public SegmentReference.Builder setParentTraceSegmentId(String value)
```
```
 Another segment id as the parent.
 
```
string parentTraceSegmentId = 3;
Parameters:

value - The parentTraceSegmentId to set.

Returns:

This builder for chaining.

clearParentTraceSegmentId

public SegmentReference.Builder clearParentTraceSegmentId()

 Another segment id as the parent.

string parentTraceSegmentId = 3;

Returns:: This builder for chaining.

setParentTraceSegmentIdBytes
```
public SegmentReference.Builder setParentTraceSegmentIdBytes(com.google.protobuf.ByteString value)
```
```
 Another segment id as the parent.
 
```
string parentTraceSegmentId = 3;
Parameters:

value - The bytes for parentTraceSegmentId to set.

Returns:

This builder for chaining.

getParentSpanId
```
public int getParentSpanId()
```
```
 The span id in the parent trace segment.
 
```
int32 parentSpanId = 4;
Specified by:

getParentSpanId in interface SegmentReferenceOrBuilder

Returns:

The parentSpanId.

setParentSpanId
```
public SegmentReference.Builder setParentSpanId(int value)
```
```
 The span id in the parent trace segment.
 
```
int32 parentSpanId = 4;
Parameters:

value - The parentSpanId to set.

Returns:

This builder for chaining.

clearParentSpanId

public SegmentReference.Builder clearParentSpanId()

 The span id in the parent trace segment.

int32 parentSpanId = 4;

Returns:: This builder for chaining.

getParentService

public String getParentService()

 The service logic name of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentService = 5;

Specified by:: getParentService in interface SegmentReferenceOrBuilder
Returns:: The parentService.

getParentServiceBytes

public com.google.protobuf.ByteString getParentServiceBytes()

 The service logic name of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentService = 5;

Specified by:: getParentServiceBytes in interface SegmentReferenceOrBuilder
Returns:: The bytes for parentService.

setParentService

public SegmentReference.Builder setParentService(String value)

 The service logic name of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentService = 5;

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

clearParentService

public SegmentReference.Builder clearParentService()

 The service logic name of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentService = 5;

Returns:: This builder for chaining.

setParentServiceBytes

public SegmentReference.Builder setParentServiceBytes(com.google.protobuf.ByteString value)

 The service logic name of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentService = 5;

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

getParentServiceInstance

public String getParentServiceInstance()

 The service logic name instance of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentServiceInstance = 6;

Specified by:: getParentServiceInstance in interface SegmentReferenceOrBuilder
Returns:: The parentServiceInstance.

getParentServiceInstanceBytes

public com.google.protobuf.ByteString getParentServiceInstanceBytes()

 The service logic name instance of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentServiceInstance = 6;

Specified by:: getParentServiceInstanceBytes in interface SegmentReferenceOrBuilder
Returns:: The bytes for parentServiceInstance.

setParentServiceInstance

public SegmentReference.Builder setParentServiceInstance(String value)

 The service logic name instance of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentServiceInstance = 6;

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

clearParentServiceInstance

public SegmentReference.Builder clearParentServiceInstance()

 The service logic name instance of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentServiceInstance = 6;

Returns:: This builder for chaining.

setParentServiceInstanceBytes

public SegmentReference.Builder setParentServiceInstanceBytes(com.google.protobuf.ByteString value)

 The service logic name instance of the parent segment.
 If refType == CrossThread, this name is as same as the trace segment.

string parentServiceInstance = 6;

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

getParentEndpoint

public String getParentEndpoint()

 The endpoint name of the parent segment.
 **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 In a trace segment, the endpoint name is the name of first entry span.

string parentEndpoint = 7;

Specified by:: getParentEndpoint in interface SegmentReferenceOrBuilder
Returns:: The parentEndpoint.

getParentEndpointBytes

public com.google.protobuf.ByteString getParentEndpointBytes()

 The endpoint name of the parent segment.
 **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 In a trace segment, the endpoint name is the name of first entry span.

string parentEndpoint = 7;

Specified by:: getParentEndpointBytes in interface SegmentReferenceOrBuilder
Returns:: The bytes for parentEndpoint.

setParentEndpoint

public SegmentReference.Builder setParentEndpoint(String value)

 The endpoint name of the parent segment.
 **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 In a trace segment, the endpoint name is the name of first entry span.

string parentEndpoint = 7;

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

clearParentEndpoint

public SegmentReference.Builder clearParentEndpoint()

 The endpoint name of the parent segment.
 **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 In a trace segment, the endpoint name is the name of first entry span.

string parentEndpoint = 7;

Returns:: This builder for chaining.

setParentEndpointBytes

public SegmentReference.Builder setParentEndpointBytes(com.google.protobuf.ByteString value)

 The endpoint name of the parent segment.
 **Endpoint**. A path in a service for incoming requests, such as an HTTP URI path or a gRPC service class + method signature.
 In a trace segment, the endpoint name is the name of first entry span.

string parentEndpoint = 7;

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