io.opentelemetry.correlationcontext

Interface CorrelationContext.Builder

Enclosing interface:

CorrelationContext

public static interface CorrelationContext.Builder

Builder for the CorrelationContext class.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
CorrelationContext	build() Creates a CorrelationContext from this builder.
CorrelationContext.Builder	put(String key, String value, EntryMetadata entryMetadata) Adds the key/value pair and metadata regardless of whether the key is present.
CorrelationContext.Builder	remove(String key) Removes the key if it exists.
CorrelationContext.Builder	setNoParent() Sets the option to become a root CorrelationContext with no parent.
CorrelationContext.Builder	setParent(io.grpc.Context context) Sets the parent CorrelationContext to use from the specified Context.
CorrelationContext.Builder	setParent(CorrelationContext parent) Sets the parent CorrelationContext to use.

Method Detail

setParent

CorrelationContext.Builder setParent(CorrelationContext parent)

Sets the parent CorrelationContext to use. If no parent is provided, the value of CorrelationContextManager.getCurrentContext() at build() time will be used as parent, unless setNoParent() was called.

This must be used to create a CorrelationContext when manual Context propagation is used.

If called multiple times, only the last specified value will be used.

Parameters:

parent - the CorrelationContext used as parent, not null.

Returns:

this.

Throws:

NullPointerException - if parent is null.

Since:

0.1.0

See Also:

setNoParent()

setParent

CorrelationContext.Builder setParent(io.grpc.Context context)

Sets the parent CorrelationContext to use from the specified Context. If no parent CorrelationContext is provided, the value of CorrelationContextManager.getCurrentContext() at build() time will be used as parent, unless setNoParent() was called.

If no parent CorrelationContext is available in the specified Context, the resulting CorrelationContext will become a root instance, as if setNoParent() had been called.

This must be used to create a CorrelationContext when manual Context propagation is used.

If called multiple times, only the last specified value will be used.

Parameters:

context - the Context.

Returns:

this.

Throws:

NullPointerException - if context is null.

Since:

0.7.0

See Also:

setNoParent()

setNoParent

CorrelationContext.Builder setNoParent()

Sets the option to become a root CorrelationContext with no parent. If not called, the value provided using setParent(CorrelationContext) or otherwise CorrelationContextManager.getCurrentContext() at build() time will be used as parent.

Returns:

this.

Since:

0.1.0

put

CorrelationContext.Builder put(String key,
                               String value,
                               EntryMetadata entryMetadata)

Adds the key/value pair and metadata regardless of whether the key is present.

Parameters:

key - the String key which will be set.

value - the String value to set for the given key.

entryMetadata - the EntryMetadata associated with this Entry.

Returns:

this

Since:

0.1.0

remove

CorrelationContext.Builder remove(String key)

Removes the key if it exists.

Parameters:

key - the String key which will be removed.

Returns:

this

Since:

0.1.0

build

CorrelationContext build()

Creates a CorrelationContext from this builder.

Returns:

a CorrelationContext with the same entries as this builder.

Since:

0.1.0