Package io.opentelemetry.proto.trace.v1

Enum SpanFlags

java.lang.Object
java.lang.Enum<SpanFlags>
io.opentelemetry.proto.trace.v1.SpanFlags
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SpanFlags>, java.lang.constant.Constable
@Generated public enum SpanFlags extends Enum<SpanFlags> implements com.google.protobuf.ProtocolMessageEnum
 SpanFlags represents constants used to interpret the
 Span.flags field, which is protobuf 'fixed32' type and is to
 be used as bit-fields. Each non-zero value defined in this enum is
 a bit-mask.  To extract the bit-field, for example, use an
 expression like:

 (span.flags & SPAN_FLAGS_TRACE_FLAGS_MASK)

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

 Note that Span flags were introduced in version 1.1 of the
 OpenTelemetry protocol.  Older Span producers do not set this
 field, consequently consumers should not rely on the absence of a
 particular flag bit to indicate the presence of a particular feature.
Protobuf enum opentelemetry.proto.trace.v1.SpanFlags

  • Enum Constant Details

    • SPAN_FLAGS_DO_NOT_USE

      public static final SpanFlags SPAN_FLAGS_DO_NOT_USE
       The zero value for the enum. Should not be used for comparisons.
 Instead use bitwise "and" with the appropriate mask as shown above.
      SPAN_FLAGS_DO_NOT_USE = 0;

    • SPAN_FLAGS_TRACE_FLAGS_MASK

      public static final SpanFlags SPAN_FLAGS_TRACE_FLAGS_MASK
       Bits 0-7 are used for trace flags.
      SPAN_FLAGS_TRACE_FLAGS_MASK = 255;

    • SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK

      public static final SpanFlags SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK
       Bits 8 and 9 are used to indicate that the parent span or link span is remote.
 Bit 8 (`HAS_IS_REMOTE`) indicates whether the value is known.
 Bit 9 (`IS_REMOTE`) indicates whether the span or link is remote.
      SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK = 256;

    • SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK

      public static final SpanFlags SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK
      SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK = 512;

    • UNRECOGNIZED

      public static final SpanFlags UNRECOGNIZED

  • Field Details

    • SPAN_FLAGS_DO_NOT_USE_VALUE

      public static final int SPAN_FLAGS_DO_NOT_USE_VALUE
       The zero value for the enum. Should not be used for comparisons.
 Instead use bitwise "and" with the appropriate mask as shown above.
      SPAN_FLAGS_DO_NOT_USE = 0;
      See Also:

    • SPAN_FLAGS_TRACE_FLAGS_MASK_VALUE

      public static final int SPAN_FLAGS_TRACE_FLAGS_MASK_VALUE
       Bits 0-7 are used for trace flags.
      SPAN_FLAGS_TRACE_FLAGS_MASK = 255;
      See Also:

    • SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK_VALUE

      public static final int SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK_VALUE
       Bits 8 and 9 are used to indicate that the parent span or link span is remote.
 Bit 8 (`HAS_IS_REMOTE`) indicates whether the value is known.
 Bit 9 (`IS_REMOTE`) indicates whether the span or link is remote.
      SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK = 256;
      See Also:

    • SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK_VALUE

      public static final int SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK_VALUE
      SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK = 512;
      See Also:

  • Method Details

    • values

      public static SpanFlags[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SpanFlags valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static SpanFlags valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static SpanFlags forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<SpanFlags> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static SpanFlags valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null