Package io.opentelemetry.api.common

Class Attributes

java.lang.Object

io.opentelemetry.api.internal.ImmutableKeyValuePairs<AttributeKey,Object>

io.opentelemetry.api.common.Attributes

All Implemented Interfaces:

ReadableAttributes

@Immutable
public abstract class Attributes
extends ImmutableKeyValuePairs<AttributeKey,Object>
implements ReadableAttributes

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.

Constructor Summary

Constructors

Constructor	Description
Attributes()

Method Summary

Modifier and Type	Method	Description
static AttributesBuilder	builder()	Returns a new AttributesBuilder instance for creating arbitrary Attributes.
static AttributesBuilder	builder(ReadableAttributes attributes)	Returns a new AttributesBuilder instance from ReadableAttributes.
static Attributes	empty()	Returns a Attributes instance with no attributes.
void	forEach(AttributeConsumer consumer)	Iterates over all the key-value pairs of attributes contained by this instance.
<T> T	get(AttributeKey<T> key)
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.
abstract AttributesBuilder	toBuilder()	Returns a new AttributesBuilder instance populated with the data of this Attributes.

Methods inherited from class io.opentelemetry.api.internal.ImmutableKeyValuePairs

data, get, isEmpty, size, sortAndFilter, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.api.common.ReadableAttributes

isEmpty, size

Constructor Detail

Attributes

public Attributes()

Method Detail

get

public <T> T get(AttributeKey<T> key)

Specified by:

get in interface ReadableAttributes

forEach

public void forEach(AttributeConsumer consumer)

Description copied from interface: ReadableAttributes

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

Specified by:

forEach in interface ReadableAttributes

empty

public static Attributes empty()

Returns a Attributes instance with no attributes.

of

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

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

of

public 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

public 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

public 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

public 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

public 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

public static AttributesBuilder builder()

Returns a new AttributesBuilder instance for creating arbitrary Attributes.

builder

public static AttributesBuilder builder(ReadableAttributes attributes)

Returns a new AttributesBuilder instance from ReadableAttributes.

toBuilder

public abstract AttributesBuilder toBuilder()

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