Package io.opentelemetry.proto.trace.v1

Class Span.Link.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<Span.Link,Span.Link.Builder>
io.opentelemetry.proto.trace.v1.Span.Link.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Span.LinkOrBuilder, Cloneable
Enclosing class:
Span.Link
public static final class Span.Link.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Span.Link,Span.Link.Builder> implements Span.LinkOrBuilder
 A pointer from the current span to another span in the same trace or in a
 different trace. For example, this can be used in batching operations,
 where a single batch handler processes multiple requests from different
 traces or when the handler receives a request from a different project.
Protobuf type opentelemetry.proto.trace.v1.Span.Link

  • Method Details

    • getTraceId

      public com.google.protobuf.ByteString getTraceId()
       A unique identifier of a trace that this linked span is part of. The ID is a
 16-byte array.
      bytes trace_id = 1 [json_name = "traceId"];
      Specified by:
      getTraceId in interface Span.LinkOrBuilder
      Returns:
      The traceId.

    • setTraceId

      public Span.Link.Builder setTraceId(com.google.protobuf.ByteString value)
       A unique identifier of a trace that this linked span is part of. The ID is a
 16-byte array.
      bytes trace_id = 1 [json_name = "traceId"];
      Parameters:
      value - The traceId to set.
      Returns:
      This builder for chaining.

    • clearTraceId

      public Span.Link.Builder clearTraceId()
       A unique identifier of a trace that this linked span is part of. The ID is a
 16-byte array.
      bytes trace_id = 1 [json_name = "traceId"];
      Returns:
      This builder for chaining.

    • getSpanId

      public com.google.protobuf.ByteString getSpanId()
       A unique identifier for the linked span. The ID is an 8-byte array.
      bytes span_id = 2 [json_name = "spanId"];
      Specified by:
      getSpanId in interface Span.LinkOrBuilder
      Returns:
      The spanId.

    • setSpanId

      public Span.Link.Builder setSpanId(com.google.protobuf.ByteString value)
       A unique identifier for the linked span. The ID is an 8-byte array.
      bytes span_id = 2 [json_name = "spanId"];
      Parameters:
      value - The spanId to set.
      Returns:
      This builder for chaining.

    • clearSpanId

      public Span.Link.Builder clearSpanId()
       A unique identifier for the linked span. The ID is an 8-byte array.
      bytes span_id = 2 [json_name = "spanId"];
      Returns:
      This builder for chaining.

    • getTraceState

      public String getTraceState()
       The trace_state associated with the link.
      string trace_state = 3 [json_name = "traceState"];
      Specified by:
      getTraceState in interface Span.LinkOrBuilder
      Returns:
      The traceState.

    • getTraceStateBytes

      public com.google.protobuf.ByteString getTraceStateBytes()
       The trace_state associated with the link.
      string trace_state = 3 [json_name = "traceState"];
      Specified by:
      getTraceStateBytes in interface Span.LinkOrBuilder
      Returns:
      The bytes for traceState.

    • setTraceState

      public Span.Link.Builder setTraceState(String value)
       The trace_state associated with the link.
      string trace_state = 3 [json_name = "traceState"];
      Parameters:
      value - The traceState to set.
      Returns:
      This builder for chaining.

    • clearTraceState

      public Span.Link.Builder clearTraceState()
       The trace_state associated with the link.
      string trace_state = 3 [json_name = "traceState"];
      Returns:
      This builder for chaining.

    • setTraceStateBytes

      public Span.Link.Builder setTraceStateBytes(com.google.protobuf.ByteString value)
       The trace_state associated with the link.
      string trace_state = 3 [json_name = "traceState"];
      Parameters:
      value - The bytes for traceState to set.
      Returns:
      This builder for chaining.

    • getAttributesList

      public List<KeyValue> getAttributesList()
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];
      Specified by:
      getAttributesList in interface Span.LinkOrBuilder

    • getAttributesCount

      public int getAttributesCount()
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];
      Specified by:
      getAttributesCount in interface Span.LinkOrBuilder

    • getAttributes

      public KeyValue getAttributes(int index)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];
      Specified by:
      getAttributes in interface Span.LinkOrBuilder

    • setAttributes

      public Span.Link.Builder setAttributes(int index, KeyValue value)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • setAttributes

      public Span.Link.Builder setAttributes(int index, KeyValue.Builder builderForValue)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • addAttributes

      public Span.Link.Builder addAttributes(KeyValue value)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • addAttributes

      public Span.Link.Builder addAttributes(int index, KeyValue value)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • addAttributes

      public Span.Link.Builder addAttributes(KeyValue.Builder builderForValue)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • addAttributes

      public Span.Link.Builder addAttributes(int index, KeyValue.Builder builderForValue)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • addAllAttributes

      public Span.Link.Builder addAllAttributes(Iterable<? extends KeyValue> values)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • clearAttributes

      public Span.Link.Builder clearAttributes()
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • removeAttributes

      public Span.Link.Builder removeAttributes(int index)
       A collection of attribute key/value pairs on the link.
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
 The behavior of software that receives duplicated keys can be unpredictable.
      repeated .opentelemetry.proto.common.v1.KeyValue attributes = 4 [json_name = "attributes"];

    • getDroppedAttributesCount

      public int getDroppedAttributesCount()
       The number of dropped attributes. If the value is 0,
 then no attributes were dropped.
      uint32 dropped_attributes_count = 5 [json_name = "droppedAttributesCount"];
      Specified by:
      getDroppedAttributesCount in interface Span.LinkOrBuilder
      Returns:
      The droppedAttributesCount.

    • setDroppedAttributesCount

      public Span.Link.Builder setDroppedAttributesCount(int value)
       The number of dropped attributes. If the value is 0,
 then no attributes were dropped.
      uint32 dropped_attributes_count = 5 [json_name = "droppedAttributesCount"];
      Parameters:
      value - The droppedAttributesCount to set.
      Returns:
      This builder for chaining.

    • clearDroppedAttributesCount

      public Span.Link.Builder clearDroppedAttributesCount()
       The number of dropped attributes. If the value is 0,
 then no attributes were dropped.
      uint32 dropped_attributes_count = 5 [json_name = "droppedAttributesCount"];
      Returns:
      This builder for chaining.

    • getFlags

      public int getFlags()
       Flags, a bit field.

 Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
 Context specification. To read the 8-bit W3C trace flag, use
 `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.

 See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.

 Bits 8 and 9 represent the 3 states of whether the link is remote.
 The states are (unknown, is not remote, is remote).
 To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
 To read whether the link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.

 Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
 When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.

 [Optional].
      fixed32 flags = 6 [json_name = "flags"];
      Specified by:
      getFlags in interface Span.LinkOrBuilder
      Returns:
      The flags.

    • setFlags

      public Span.Link.Builder setFlags(int value)
       Flags, a bit field.

 Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
 Context specification. To read the 8-bit W3C trace flag, use
 `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.

 See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.

 Bits 8 and 9 represent the 3 states of whether the link is remote.
 The states are (unknown, is not remote, is remote).
 To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
 To read whether the link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.

 Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
 When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.

 [Optional].
      fixed32 flags = 6 [json_name = "flags"];
      Parameters:
      value - The flags to set.
      Returns:
      This builder for chaining.

    • clearFlags

      public Span.Link.Builder clearFlags()
       Flags, a bit field.

 Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace
 Context specification. To read the 8-bit W3C trace flag, use
 `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.

 See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.

 Bits 8 and 9 represent the 3 states of whether the link is remote.
 The states are (unknown, is not remote, is remote).
 To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
 To read whether the link is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.

 Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
 When creating new spans, bits 10-31 (most-significant 22-bits) MUST be zero.

 [Optional].
      fixed32 flags = 6 [json_name = "flags"];
      Returns:
      This builder for chaining.