OpenTelemetry Java 1.49.0 · io.opentelemetry.api.common.Value

Value mirrors the proto AnyValue message type, and is used to model any type.

It can be used to represent:

Primitive values via of(long), of(String), of(boolean), of(double).
String-keyed maps (i.e. associative arrays, dictionaries) via of(KeyValue...), of(Map). Note, because map values are type Value, maps can be nested within other maps.
Arrays (heterogeneous or homogenous) via of(Value[]). Note, because array values are type Value, arrays can contain primitives, complex types like maps or arrays, or any combination.
Raw bytes via of(byte[])

Currently, Value is only used as an argument for io.opentelemetry.api.logs.LogRecordBuilder#setBody(Value).

Method Summary

Modifier and Type	Method and Description
public String	asString() Return a string encoding of this `Value`.
public ValueType	getType() Returns the type of this `Value`.
public T	getValue() Returns the value for this `Value`.
public static Value<String>	of(String value) Returns an `Value` for the `String` value.
public static Value<Boolean>	of(boolean value) Returns an `Value` for the `boolean` value.
public static Value<Long>	of(long value) Returns an `Value` for the `long` value.
public static Value<Double>	of(double value) Returns an `Value` for the `double` value.
public static Value<ByteBuffer>	of(byte[] value) Returns an `Value` for the `byte[]` value.
public static Value<List<Value<?>>>	of(Value<?>... value) Returns an `Value` for the array of `Value` values.
public static Value<List<Value<?>>>	of(List<Value<?>> value) Returns an `Value` for the list of `Value` values.
public static Value<List<KeyValue>>	of(KeyValue... value) Returns an `Value` for the array of `KeyValue` values.
public static Value<List<KeyValue>>	of(Map<String, Value<?>> value) Returns an `Value` for the `Map` of key, `Value`.

Method Detail

asString back to summary

asString	back to summary
public String asString() Return a string encoding of this `Value`. This is intended to be a fallback serialized representation in case there is no suitable encoding that can utilize `getType()` / `getValue()` to serialize specific types. Warning No guarantees are made about the encoding of this string response. It MAY change in a future minor release. If you need a reliable string encoding, write your own serializer.

public String asString()

Return a string encoding of this Value. This is intended to be a fallback serialized representation in case there is no suitable encoding that can utilize getType() / getValue() to serialize specific types.

Warning

No guarantees are made about the encoding of this string response. It MAY change in a future minor release. If you need a reliable string encoding, write your own serializer.

getType	back to summary
public ValueType getType() Returns the type of this `Value`. Useful for building switch statements.

getValue back to summary

getValue	back to summary
public T getValue() Returns the value for this `Value`. The return type varies by `getType()` as described below: `ValueType#STRING` returns `String` `ValueType#BOOLEAN` returns `boolean` `ValueType#LONG` returns `long` `ValueType#DOUBLE` returns `double` `ValueType#ARRAY` returns `List` of `Value` `ValueType#KEY_VALUE_LIST` returns `List` of `KeyValue` `ValueType#BYTES` returns read only `ByteBuffer`. See `ByteBuffer#asReadOnlyBuffer()`.

public T getValue()

Returns the value for this Value.

The return type varies by getType() as described below:

ValueType#STRING returns String
ValueType#BOOLEAN returns boolean
ValueType#LONG returns long
ValueType#DOUBLE returns double
ValueType#ARRAY returns List of Value
ValueType#KEY_VALUE_LIST returns List of KeyValue
ValueType#BYTES returns read only ByteBuffer. See ByteBuffer#asReadOnlyBuffer().

of	back to summary
public static Value<String> of(String value) Returns an `Value` for the `String` value.

of	back to summary
public static Value<Boolean> of(boolean value) Returns an `Value` for the `boolean` value.

of	back to summary
public static Value<Long> of(long value) Returns an `Value` for the `long` value.

of	back to summary
public static Value<Double> of(double value) Returns an `Value` for the `double` value.

of	back to summary
public static Value<ByteBuffer> of(byte[] value) Returns an `Value` for the `byte[]` value.

of	back to summary
public static Value<List<Value<?>>> of(Value<?>... value) Returns an `Value` for the array of `Value` values.

of	back to summary
public static Value<List<Value<?>>> of(List<Value<?>> value) Returns an `Value` for the list of `Value` values.

of	back to summary
public static Value<List<KeyValue>> of(KeyValue... value) Returns an `Value` for the array of `KeyValue` values. `KeyValue#getKey()` values should not repeat - duplicates may be dropped.

of	back to summary
public static Value<List<KeyValue>> of(Map<String, Value<?>> value) Returns an `Value` for the `Map` of key, `Value`.

public Interface Value<T>

Method Summary

Method Detail