Attributes (opentelemetry-api 0.9.1 API)

java.lang.Object
- io.opentelemetry.common.Attributes

All Implemented Interfaces:

ReadableAttributes
```
@Immutable
public abstract class Attributes
extends 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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Attributes.Builder
Enables the creation of an Attributes instance with an arbitrary number of key-value pairs.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Attributes.Builder` Enables the creation of an `Attributes` instance with an arbitrary number of key-value pairs.

Constructor Summary

Constructors
Constructor and Description

Attributes()

Constructors
Constructor and Description
`Attributes()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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)`
`V`	`get(K key)`
`boolean`	`isEmpty()`
`static Attributes.Builder`	`newBuilder()` Returns a new `Attributes.Builder` instance for creating arbitrary `Attributes`.
`static Attributes.Builder`	`newBuilder(ReadableAttributes attributes)` Returns a new `Attributes.Builder` instance from ReadableAttributes.
`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()`
`abstract Attributes.Builder`	`toBuilder()` Returns a new `Attributes.Builder` instance populated with the data of this `Attributes`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.opentelemetry.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.

newBuilder
```
public static Attributes.Builder newBuilder()
```
Returns a new Attributes.Builder instance for creating arbitrary Attributes.

newBuilder

public static Attributes.Builder newBuilder(ReadableAttributes attributes)

Returns a new Attributes.Builder instance from ReadableAttributes.

toBuilder
```
public abstract Attributes.Builder toBuilder()
```
Returns a new Attributes.Builder instance populated with the data of this Attributes.

size
```
public int size()
```

isEmpty
```
public boolean isEmpty()
```

get
```
@Nullable
public V get(K key)
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Attributes

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.opentelemetry.common.ReadableAttributes

Constructor Detail

Attributes

Method Detail

get

forEach

empty

of

of

of

of

of

of

newBuilder

newBuilder

toBuilder

size

isEmpty

get

toString