Package io.opentelemetry.api.common

Interface AttributesBuilder

All Known Implementing Classes:

ArrayBackedAttributesBuilder

public interface AttributesBuilder

A builder of Attributes supporting an arbitrary number of key-value pairs.

Method Summary

Modifier and Type	Method	Description
Attributes	build()	Create the Attributes from this.
<T> AttributesBuilder	put(AttributeKey<java.lang.Long> key, int value)	Puts a AttributeKey with associated value into this.
default <T> AttributesBuilder	put(AttributeKey<java.util.List<T>> key, T... value)	Puts a List attribute into this.
<T> AttributesBuilder	put(AttributeKey<T> key, T value)	Puts a AttributeKey with associated value into this.
default AttributesBuilder	put(java.lang.String key, boolean value)	Puts a boolean attribute into this.
default AttributesBuilder	put(java.lang.String key, boolean... value)	Puts a Boolean array attribute into this.
default AttributesBuilder	put(java.lang.String key, double value)	Puts a double attribute into this.
default AttributesBuilder	put(java.lang.String key, double... value)	Puts a Double array attribute into this.
default AttributesBuilder	put(java.lang.String key, long value)	Puts a long attribute into this.
default AttributesBuilder	put(java.lang.String key, long... value)	Puts a Long array attribute into this.
default AttributesBuilder	put(java.lang.String key, java.lang.String value)	Puts a String attribute into this.
default AttributesBuilder	put(java.lang.String key, java.lang.String... value)	Puts a String array attribute into this.
AttributesBuilder	putAll(Attributes attributes)	Puts all the provided attributes into this Builder.
default <T> AttributesBuilder	remove(AttributeKey<T> key)	Remove all attributes where AttributeKey.getKey() and AttributeKey.getType() match the key.
default AttributesBuilder	removeIf(java.util.function.Predicate<AttributeKey<?>> filter)	Remove all attributes that satisfy the given predicate.

Method Detail

build

Attributes build()

Create the Attributes from this.

put

<T> AttributesBuilder put(AttributeKey<java.lang.Long> key,
                          int value)

Puts a AttributeKey with associated value into this.

The type parameter is unused.

put

<T> AttributesBuilder put(AttributeKey<T> key,
                          T value)

Puts a AttributeKey with associated value into this.

put

default AttributesBuilder put(java.lang.String key,
                              java.lang.String value)

Puts a String attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default AttributesBuilder put(java.lang.String key,
                              long value)

Puts a long attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default AttributesBuilder put(java.lang.String key,
                              double value)

Puts a double attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default AttributesBuilder put(java.lang.String key,
                              boolean value)

Puts a boolean attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default AttributesBuilder put(java.lang.String key,
                              java.lang.String... value)

Puts a String array attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default <T> AttributesBuilder put(AttributeKey<java.util.List<T>> key,
                                  T... value)

Puts a List attribute into this.

Returns:

this Builder

put

default AttributesBuilder put(java.lang.String key,
                              long... value)

Puts a Long array attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default AttributesBuilder put(java.lang.String key,
                              double... value)

Puts a Double array attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

put

default AttributesBuilder put(java.lang.String key,
                              boolean... value)

Puts a Boolean array attribute into this.

Note: It is strongly recommended to use put(AttributeKey, Object), and pre-allocate your keys, if possible.

Returns:

this Builder

putAll

AttributesBuilder putAll(Attributes attributes)

Puts all the provided attributes into this Builder.

Returns:

this Builder

remove

default <T> AttributesBuilder remove(AttributeKey<T> key)

Remove all attributes where AttributeKey.getKey() and AttributeKey.getType() match the key.

Returns:

this Builder

removeIf

default AttributesBuilder removeIf(java.util.function.Predicate<AttributeKey<?>> filter)

Remove all attributes that satisfy the given predicate. Errors or runtime exceptions thrown by the predicate are relayed to the caller.

Returns:

this Builder