io.opentelemetry.sdk.trace.data

Interface SpanData.Status

All Known Implementing Classes:

ImmutableStatus

Enclosing interface:

SpanData

public static interface SpanData.Status

Defines the status of a Span by providing a standard StatusCanonicalCode in conjunction with an optional descriptive message.

Method Summary

Modifier and Type	Method and Description
io.opentelemetry.trace.StatusCanonicalCode	getCanonicalCode() Returns the canonical status code.
String	getDescription() Returns the description of this Status for human consumption.
default boolean	isOk() Returns true if this Status is ok, i.e., status is not set, or has been overridden to be ok by an operator.
default boolean	isUnset() Returns true if this Status is UNSET, i.e., not an error.

Method Detail

getCanonicalCode

io.opentelemetry.trace.StatusCanonicalCode getCanonicalCode()

Returns the canonical status code.

Returns:

the canonical status code.

getDescription

@Nullable
String getDescription()

Returns the description of this Status for human consumption.

Returns:

the description of this Status.

isUnset

default boolean isUnset()

Returns true if this Status is UNSET, i.e., not an error.

Returns:

true if this Status is UNSET.

isOk

default boolean isOk()

Returns true if this Status is ok, i.e., status is not set, or has been overridden to be ok by an operator.

Returns:

true if this Status is OK or UNSET.