Interface BaggageView

All Known Subinterfaces:
Baggage, BaggageInScope
public interface BaggageView
Inspired by OpenZipkin Brave's BaggageField. Represents a single, immutable baggage entry.
Since:
1.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final BaggageView
    NOOP
    A noop implementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    get()
    Retrieves baggage value.
    @Nullable String
    get(TraceContext traceContext)
    Retrieves baggage value from the given TraceContext.
    String
    name()
    Retrieves baggage name.

  • Field Details

    • NOOP

      static final BaggageView NOOP
      A noop implementation.

  • Method Details

    • name

      String name()
      Retrieves baggage name.
      Returns:
      name of the baggage entry

    • get

      @Nullable String get()
      Retrieves baggage value.
      Returns:
      value of the baggage entry or null if not set.

    • get

      @Nullable String get(TraceContext traceContext)
      Retrieves baggage value from the given TraceContext.
      Parameters:
      traceContext - context containing baggage
      Returns:
      value of the baggage entry or null if not set.