Package io.opentelemetry.api.common

Class Labels

java.lang.Object

io.opentelemetry.api.common.Labels

@Immutable
public abstract class Labels
extends Object

An immutable container for labels, which are pairs of String.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
Labels()

Method Summary

Modifier and Type	Method	Description
static Labels.Builder	builder()	Creates a new Labels.Builder instance for creating arbitrary Labels.
static Labels	empty()	Returns a Labels instance with no attributes.
abstract void	forEach(BiConsumer<String,String> consumer)
V	get(K key)
boolean	isEmpty()
static Labels	of(String[] keyValueLabelPairs)
static Labels	of(String key, String value)	Returns a Labels instance with a single key-value pair.
static Labels	of(String key1, String value1, String key2, String value2)	Returns a Labels instance with two key-value pairs.
static Labels	of(String key1, String value1, String key2, String value2, String key3, String value3)	Returns a Labels instance with three key-value pairs.
static Labels	of(String key1, String value1, String key2, String value2, String key3, String value3, String key4, String value4)	Returns a Labels instance with four key-value pairs.
static Labels	of(String key1, String value1, String key2, String value2, String key3, String value3, String key4, String value4, String key5, String value5)	Returns a Labels instance with five key-value pairs.
int	size()
Labels.Builder	toBuilder()	Create a Labels.Builder pre-populated with the contents of this Labels instance.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Labels

public Labels()

Method Detail

forEach

public abstract void forEach(BiConsumer<String,String> consumer)

empty

public static Labels empty()

Returns a Labels instance with no attributes.

of

public static Labels of(String key,
                        String value)

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

of

public static Labels of(String key1,
                        String value1,
                        String key2,
                        String value2)

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

of

public static Labels of(String key1,
                        String value1,
                        String key2,
                        String value2,
                        String key3,
                        String value3)

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

of

public static Labels of(String key1,
                        String value1,
                        String key2,
                        String value2,
                        String key3,
                        String value3,
                        String key4,
                        String value4)

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

of

public static Labels of(String key1,
                        String value1,
                        String key2,
                        String value2,
                        String key3,
                        String value3,
                        String key4,
                        String value4,
                        String key5,
                        String value5)

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

of

public static Labels of(String[] keyValueLabelPairs)

toBuilder

public Labels.Builder toBuilder()

Create a Labels.Builder pre-populated with the contents of this Labels instance.

builder

public static Labels.Builder builder()

Creates a new Labels.Builder instance for creating arbitrary Labels.

size

public int size()

isEmpty

public boolean isEmpty()

get

@Nullable
public V get(K key)

toString

public String toString()

Overrides:

toString in class Object