Class SegmentReference

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.apache.skywalking.apm.network.language.agent.v3.SegmentReference
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SegmentReferenceOrBuilder

public final class SegmentReference extends com.google.protobuf.GeneratedMessageV3 implements SegmentReferenceOrBuilder
 Segment reference represents the link between two existing segment.
 
Protobuf type skywalking.v3.SegmentReference
See Also:
  • Field Details

    • REFTYPE_FIELD_NUMBER

      public static final int REFTYPE_FIELD_NUMBER
      See Also:
    • TRACEID_FIELD_NUMBER

      public static final int TRACEID_FIELD_NUMBER
      See Also:
    • PARENTTRACESEGMENTID_FIELD_NUMBER

      public static final int PARENTTRACESEGMENTID_FIELD_NUMBER
      See Also:
    • PARENTSPANID_FIELD_NUMBER

      public static final int PARENTSPANID_FIELD_NUMBER
      See Also:
    • PARENTSERVICE_FIELD_NUMBER

      public static final int PARENTSERVICE_FIELD_NUMBER
      See Also:
    • PARENTSERVICEINSTANCE_FIELD_NUMBER

      public static final int PARENTSERVICEINSTANCE_FIELD_NUMBER
      See Also:
    • PARENTENDPOINT_FIELD_NUMBER

      public static final int PARENTENDPOINT_FIELD_NUMBER
      See Also:
    • NETWORKADDRESSUSEDATPEER_FIELD_NUMBER

      public static final int NETWORKADDRESSUSEDATPEER_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3
    • 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
    • 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.
    • 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.
    • 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.
    • 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.
    • getParentSpanId

      public int getParentSpanId()
       The span id in the parent trace segment.
       
      int32 parentSpanId = 4;
      Specified by:
      getParentSpanId in interface SegmentReferenceOrBuilder
      Returns:
      The parentSpanId.
    • 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.
    • 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.
    • 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.
    • getNetworkAddressUsedAtPeer

      public String getNetworkAddressUsedAtPeer()
       The network address, including ip/hostname and port, which is used in the client side.
       Such as Client --> use 127.0.11.8:913 -> Server
       then, in the reference of entry span reported by Server, the value of this field is 127.0.11.8:913.
       This plays the important role in the SkyWalking STAM(Streaming Topology Analysis Method)
       For more details, read https://wu-sheng.github.io/STAM/
       
      string networkAddressUsedAtPeer = 8;
      Specified by:
      getNetworkAddressUsedAtPeer in interface SegmentReferenceOrBuilder
      Returns:
      The networkAddressUsedAtPeer.
    • getNetworkAddressUsedAtPeerBytes

      public com.google.protobuf.ByteString getNetworkAddressUsedAtPeerBytes()
       The network address, including ip/hostname and port, which is used in the client side.
       Such as Client --> use 127.0.11.8:913 -> Server
       then, in the reference of entry span reported by Server, the value of this field is 127.0.11.8:913.
       This plays the important role in the SkyWalking STAM(Streaming Topology Analysis Method)
       For more details, read https://wu-sheng.github.io/STAM/
       
      string networkAddressUsedAtPeer = 8;
      Specified by:
      getNetworkAddressUsedAtPeerBytes in interface SegmentReferenceOrBuilder
      Returns:
      The bytes for networkAddressUsedAtPeer.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static SegmentReference parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SegmentReference parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SegmentReference parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SegmentReference parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SegmentReference parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SegmentReference parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SegmentReference parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SegmentReference parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SegmentReference parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SegmentReference parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SegmentReference parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SegmentReference parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public SegmentReference.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static SegmentReference.Builder newBuilder()
    • newBuilder

      public static SegmentReference.Builder newBuilder(SegmentReference prototype)
    • toBuilder

      public SegmentReference.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected SegmentReference.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static SegmentReference getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SegmentReference> parser()
    • getParserForType

      public com.google.protobuf.Parser<SegmentReference> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstanceForType

      public SegmentReference getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder