Class Header

java.lang.Object
io.temporal.common.interceptors.Header

public class Header extends Object
Already serialized payload headers shared by interceptors and context propagators.

Entries supplied through getValues() should be wire-ready, including any codec encoding. Tracing and context propagation may separately opt into SDK codec processing of their own output. Encoding opt-in belongs to a key and payload instance: removing and reinserting that same instance retains its opt-in. Use putAll(Map, boolean) with false to explicitly clear it.

  • Constructor Details

    • Header

      public Header(@Nonnull io.temporal.api.common.v1.Header header)
    • Header

      public Header(@Nonnull io.temporal.api.common.v1.Header header, @Nullable PayloadCodec codec)
    • Header

      public Header(Map<String,io.temporal.api.common.v1.Payload> values)
  • Method Details

    • empty

      public static Header empty()
    • getValues

      public Map<String,io.temporal.api.common.v1.Payload> getValues()
    • putAll

      public void putAll(Map<String,io.temporal.api.common.v1.Payload> payloads, boolean encode)
      Used by opted-in header producers; ordinary interceptor entries remain wire-ready.
    • shouldEncode

      public boolean shouldEncode(String key)
      Returns whether this producer requested codec encoding for an entry.
    • getCodecDecodedValues

      public Map<String,io.temporal.api.common.v1.Payload> getCodecDecodedValues()
      Returns a private decoded view for an opted-in tracing or propagation consumer.