Package io.opentelemetry.proto.trace.v1

Enum Span.SpanKind

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Span.SpanKind>
    Enclosing class:
    Span
    public static enum Span.SpanKind
extends Enum<Span.SpanKind>
implements com.google.protobuf.ProtocolMessageEnum
     SpanKind is the type of span. Can be used to specify additional relationships between spans
 in addition to a parent/child relationship.
    Protobuf enum opentelemetry.proto.trace.v1.Span.SpanKind

    • Enum Constant Detail

      • SPAN_KIND_UNSPECIFIED

        public static final Span.SpanKind SPAN_KIND_UNSPECIFIED
         Unspecified. Do NOT use as default.
 Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.
        SPAN_KIND_UNSPECIFIED = 0;

      • SPAN_KIND_INTERNAL

        public static final Span.SpanKind SPAN_KIND_INTERNAL
         Indicates that the span represents an internal operation within an application,
 as opposed to an operation happening at the boundaries. Default value.
        SPAN_KIND_INTERNAL = 1;

      • SPAN_KIND_SERVER

        public static final Span.SpanKind SPAN_KIND_SERVER
         Indicates that the span covers server-side handling of an RPC or other
 remote network request.
        SPAN_KIND_SERVER = 2;

      • SPAN_KIND_CLIENT

        public static final Span.SpanKind SPAN_KIND_CLIENT
         Indicates that the span describes a request to some remote service.
        SPAN_KIND_CLIENT = 3;

      • SPAN_KIND_PRODUCER

        public static final Span.SpanKind SPAN_KIND_PRODUCER
         Indicates that the span describes a producer sending a message to a broker.
 Unlike CLIENT and SERVER, there is often no direct critical path latency relationship
 between producer and consumer spans. A PRODUCER span ends when the message was accepted
 by the broker while the logical processing of the message might span a much longer time.
        SPAN_KIND_PRODUCER = 4;

      • SPAN_KIND_CONSUMER

        public static final Span.SpanKind SPAN_KIND_CONSUMER
         Indicates that the span describes consumer receiving a message from a broker.
 Like the PRODUCER kind, there is often no direct critical path latency relationship
 between producer and consumer spans.
        SPAN_KIND_CONSUMER = 5;

    • Field Detail

      • SPAN_KIND_UNSPECIFIED_VALUE

        public static final int SPAN_KIND_UNSPECIFIED_VALUE
         Unspecified. Do NOT use as default.
 Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.
        SPAN_KIND_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • SPAN_KIND_INTERNAL_VALUE

        public static final int SPAN_KIND_INTERNAL_VALUE
         Indicates that the span represents an internal operation within an application,
 as opposed to an operation happening at the boundaries. Default value.
        SPAN_KIND_INTERNAL = 1;
        See Also:
        Constant Field Values

      • SPAN_KIND_SERVER_VALUE

        public static final int SPAN_KIND_SERVER_VALUE
         Indicates that the span covers server-side handling of an RPC or other
 remote network request.
        SPAN_KIND_SERVER = 2;
        See Also:
        Constant Field Values

      • SPAN_KIND_CLIENT_VALUE

        public static final int SPAN_KIND_CLIENT_VALUE
         Indicates that the span describes a request to some remote service.
        SPAN_KIND_CLIENT = 3;
        See Also:
        Constant Field Values

      • SPAN_KIND_PRODUCER_VALUE

        public static final int SPAN_KIND_PRODUCER_VALUE
         Indicates that the span describes a producer sending a message to a broker.
 Unlike CLIENT and SERVER, there is often no direct critical path latency relationship
 between producer and consumer spans. A PRODUCER span ends when the message was accepted
 by the broker while the logical processing of the message might span a much longer time.
        SPAN_KIND_PRODUCER = 4;
        See Also:
        Constant Field Values

      • SPAN_KIND_CONSUMER_VALUE

        public static final int SPAN_KIND_CONSUMER_VALUE
         Indicates that the span describes consumer receiving a message from a broker.
 Like the PRODUCER kind, there is often no direct critical path latency relationship
 between producer and consumer spans.
        SPAN_KIND_CONSUMER = 5;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static Span.SpanKind[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Span.SpanKind c : Span.SpanKind.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Span.SpanKind 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 Span.SpanKind 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 Span.SpanKind 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<Span.SpanKind> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static Span.SpanKind 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