Package brave.baggage

Class BaggagePropagationConfig.SingleBaggageField

java.lang.Object

brave.baggage.BaggagePropagationConfig

brave.baggage.BaggagePropagationConfig.SingleBaggageField

Enclosing class:

BaggagePropagationConfig

public static class BaggagePropagationConfig.SingleBaggageField
extends BaggagePropagationConfig

Holds BaggagePropagation configuration for a baggage field.

Since:

5.11

See Also:

BaggagePropagation, BaggageField

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaggagePropagationConfig.SingleBaggageField.Builder

Nested classes/interfaces inherited from class brave.baggage.BaggagePropagationConfig

BaggagePropagationConfig.SingleBaggageField

Method Summary

Modifier and Type	Method	Description
BaggageField	field()
Set<String>	keyNames()	Returns a possibly empty list of lower-case propagation key names.
static BaggagePropagationConfig.SingleBaggageField	local(BaggageField field)	Configures this field for only local propagation.
static BaggagePropagationConfig.SingleBaggageField.Builder	newBuilder(BaggageField field)
static BaggagePropagationConfig.SingleBaggageField	remote(BaggageField field)	Configures this field for remote propagation using its lower-case BaggageField.name() as the only propagation key name.
BaggagePropagationConfig.SingleBaggageField.Builder	toBuilder()	Allows decorators to reconfigure correlation of this field()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

local

public static BaggagePropagationConfig.SingleBaggageField local(BaggageField field)

Configures this field for only local propagation. This will not be read from or written to remote headers.

Since:

5.11

See Also:

remote(BaggageField)

remote

public static BaggagePropagationConfig.SingleBaggageField remote(BaggageField field)

Configures this field for remote propagation using its lower-case BaggageField.name() as the only propagation key name.

See Also:

local(BaggageField), to use different propagation key names.

newBuilder

public static BaggagePropagationConfig.SingleBaggageField.Builder newBuilder(BaggageField field)

Since:

5.11

toBuilder

public BaggagePropagationConfig.SingleBaggageField.Builder toBuilder()

Allows decorators to reconfigure correlation of this field()

Since:

5.11

See Also:

BaggagePropagationCustomizer

field

public BaggageField field()

keyNames

public Set<String> keyNames()

Returns a possibly empty list of lower-case propagation key names. When empty, the field is not propagated remotely.

Since:

5.11