Package zipkin2.proto3

Enum Span.Kind

  • All Implemented Interfaces:
    com.squareup.wire.WireEnum, java.io.Serializable, java.lang.Comparable<Span.Kind>
    Enclosing class:
    Span
    public static enum Span.Kind
extends java.lang.Enum<Span.Kind>
implements com.squareup.wire.WireEnum
    When present, kind clarifies timestamp, duration and remote_endpoint. When absent, the span is local or incomplete. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLIENT
      The span represents the client side of an RPC operation, implying the following: timestamp is the moment a request was sent to the server.
      CONSUMER
      The span represents consumption of a message from a remote broker, not time spent servicing it.
      PRODUCER
      The span represents production of a message to a remote broker, implying the following: timestamp is the moment a message was sent to a destination.
      SERVER
      The span represents the server side of an RPC operation, implying the following: timestamp is the moment a client request was received.
      SPAN_KIND_UNSPECIFIED
      Default value interpreted as absent.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static com.squareup.wire.ProtoAdapter<Span.Kind> ADAPTER  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Span.Kind fromValue​(int value)
      Return the constant for value or null.
      int getValue()  
      static Span.Kind valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Span.Kind[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SPAN_KIND_UNSPECIFIED

        public static final Span.Kind SPAN_KIND_UNSPECIFIED
        Default value interpreted as absent.

      • CLIENT

        public static final Span.Kind CLIENT
        The span represents the client side of an RPC operation, implying the following: timestamp is the moment a request was sent to the server. duration is the delay until a response or an error was received. remote_endpoint is the server.

      • SERVER

        public static final Span.Kind SERVER
        The span represents the server side of an RPC operation, implying the following: timestamp is the moment a client request was received. duration is the delay until a response was sent or an error. remote_endpoint is the client.

      • PRODUCER

        public static final Span.Kind PRODUCER
        The span represents production of a message to a remote broker, implying the following: timestamp is the moment a message was sent to a destination. duration is the delay sending the message, such as batching. remote_endpoint is the broker.

      • CONSUMER

        public static final Span.Kind CONSUMER
        The span represents consumption of a message from a remote broker, not time spent servicing it. For example, a message processor would be an in-process child span of a consumer. Consumer spans imply the following: timestamp is the moment a message was received from an origin. duration is the delay consuming the message, such as from backlog. remote_endpoint is the broker.

    • Field Detail

      • ADAPTER

        public static final com.squareup.wire.ProtoAdapter<Span.Kind> ADAPTER

    • Method Detail

      • values

        public static Span.Kind[] 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.Kind c : Span.Kind.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.Kind valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromValue

        public static Span.Kind fromValue​(int value)
        Return the constant for value or null.

      • getValue

        public int getValue()
        Specified by:
        getValue in interface com.squareup.wire.WireEnum