Package io.opentelemetry.api.common

Interface Attributes

@Immutable
public interface Attributes

An immutable container for attributes.

The keys are AttributeKeys and the values are Object instances that match the type of the provided key.

Null keys will be silently dropped.

Note: The behavior of null-valued attributes is undefined, and hence strongly discouraged.

Implementations of this interface *must* be immutable and have well-defined value-based equals/hashCode implementations. If an implementation does not strictly conform to these requirements, behavior of the OpenTelemetry APIs and default SDK cannot be guaranteed.

For this reason, it is strongly suggested that you use the implementation that is provided here via the factory methods and the AttributesBuilder.

Method Summary

Modifier and Type	Method	Description
Map<AttributeKey<?>,Object>	asMap()	Returns a read-only view of this Attributes as a Map.
static AttributesBuilder	builder()	Returns a new AttributesBuilder instance for creating arbitrary Attributes.
static Attributes	empty()	Returns a Attributes instance with no attributes.
void	forEach(BiConsumer<? super AttributeKey<?>,? super Object> consumer)	Iterates over all the key-value pairs of attributes contained by this instance.
<T> T	get(AttributeKey<T> key)	Returns the value for the given AttributeKey, or null if not found.
boolean	isEmpty()	Whether there are any attributes contained in this.
static <T> Attributes	of(AttributeKey<T> key, T value)	Returns a Attributes instance with a single key-value pair.
static <T,U> Attributes	of(AttributeKey<T> key1, T value1, AttributeKey<U> key2, U value2)	Returns a Attributes instance with two key-value pairs.
static <T,U,V> Attributes	of(AttributeKey<T> key1, T value1, AttributeKey<U> key2, U value2, AttributeKey<V> key3, V value3)	Returns a Attributes instance with three key-value pairs.
static <T,U,V,W> Attributes	of(AttributeKey<T> key1, T value1, AttributeKey<U> key2, U value2, AttributeKey<V> key3, V value3, AttributeKey<W> key4, W value4)	Returns a Attributes instance with four key-value pairs.
static <T,U,V,W,X> Attributes	of(AttributeKey<T> key1, T value1, AttributeKey<U> key2, U value2, AttributeKey<V> key3, V value3, AttributeKey<W> key4, W value4, AttributeKey<X> key5, X value5)	Returns a Attributes instance with five key-value pairs.
static <T,U,V,W,X,Y> Attributes	of(AttributeKey<T> key1, T value1, AttributeKey<U> key2, U value2, AttributeKey<V> key3, V value3, AttributeKey<W> key4, W value4, AttributeKey<X> key5, X value5, AttributeKey<Y> key6, Y value6)	Returns a Attributes instance with the given key-value pairs.
int	size()	The number of attributes contained in this.
AttributesBuilder	toBuilder()	Returns a new AttributesBuilder instance populated with the data of this Attributes.

Method Detail

get

@Nullable
<T> T get(AttributeKey<T> key)

Returns the value for the given AttributeKey, or null if not found.

forEach

void forEach(BiConsumer<? super AttributeKey<?>,? super Object> consumer)

Iterates over all the key-value pairs of attributes contained by this instance.

size

int size()

The number of attributes contained in this.

isEmpty

boolean isEmpty()

Whether there are any attributes contained in this.

asMap

Map<AttributeKey<?>,Object> asMap()

Returns a read-only view of this Attributes as a Map.

empty

static Attributes empty()

Returns a Attributes instance with no attributes.

of

static <T> Attributes of(AttributeKey<T> key,
                         T value)

Returns a Attributes instance with a single key-value pair.

of

static <T,U> Attributes of(AttributeKey<T> key1,
                                 T value1,
                                 AttributeKey<U> key2,
                                 U value2)

Returns a Attributes instance with two key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

of

static <T,U,V> Attributes of(AttributeKey<T> key1,
                                         T value1,
                                         AttributeKey<U> key2,
                                         U value2,
                                         AttributeKey<V> key3,
                                         V value3)

Returns a Attributes instance with three key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

of

static <T,U,V,W> Attributes of(AttributeKey<T> key1,
                                                 T value1,
                                                 AttributeKey<U> key2,
                                                 U value2,
                                                 AttributeKey<V> key3,
                                                 V value3,
                                                 AttributeKey<W> key4,
                                                 W value4)

Returns a Attributes instance with four key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

of

static <T,U,V,W,X> Attributes of(AttributeKey<T> key1,
                                                         T value1,
                                                         AttributeKey<U> key2,
                                                         U value2,
                                                         AttributeKey<V> key3,
                                                         V value3,
                                                         AttributeKey<W> key4,
                                                         W value4,
                                                         AttributeKey<X> key5,
                                                         X value5)

Returns a Attributes instance with five key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

of

static <T,U,V,W,X,Y> Attributes of(AttributeKey<T> key1,
                                                                 T value1,
                                                                 AttributeKey<U> key2,
                                                                 U value2,
                                                                 AttributeKey<V> key3,
                                                                 V value3,
                                                                 AttributeKey<W> key4,
                                                                 W value4,
                                                                 AttributeKey<X> key5,
                                                                 X value5,
                                                                 AttributeKey<Y> key6,
                                                                 Y value6)

Returns a Attributes instance with the given key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

builder

static AttributesBuilder builder()

Returns a new AttributesBuilder instance for creating arbitrary Attributes.

toBuilder

AttributesBuilder toBuilder()

Returns a new AttributesBuilder instance populated with the data of this Attributes.