Package io.opentelemetry.sdk.trace.data

Interface StatusData

public interface StatusData

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

Method Summary

Modifier and Type	Method	Description
static StatusData	create(io.opentelemetry.api.trace.StatusCode code, String description)	Returns a StatusData with the given code and description.
static StatusData	error()	Returns a StatusData indicating an error occurred.
String	getDescription()	Returns the description of this Status for human consumption.
io.opentelemetry.api.trace.StatusCode	getStatusCode()	Returns the status code.
default boolean	isOk()	Deprecated. Compare getStatusCode() with StatusCode.ERROR
default boolean	isUnset()	Deprecated. Compare getStatusCode() with StatusCode.UNSET
static StatusData	ok()	Returns a StatusData indicating the operation has been validated by an application developer or operator to have completed successfully.
static StatusData	unset()	Returns the default StatusData.

Method Detail

ok

static StatusData ok()

Returns a StatusData indicating the operation has been validated by an application developer or operator to have completed successfully.

unset

static StatusData unset()

Returns the default StatusData.

error

static StatusData error()

Returns a StatusData indicating an error occurred.

create

static StatusData create(io.opentelemetry.api.trace.StatusCode code,
                         @Nullable
                         String description)

Returns a StatusData with the given code and description. If description is null, the returned StatusData does not have a description.

getStatusCode

io.opentelemetry.api.trace.StatusCode getStatusCode()

Returns the status code.

getDescription

@Nullable
String getDescription()

Returns the description of this Status for human consumption.

Returns:

the description of this Status.

isUnset

@Deprecated
default boolean isUnset()

Deprecated.

Compare getStatusCode() with StatusCode.UNSET

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

Returns:

true if this Status is UNSET.

isOk

@Deprecated
default boolean isOk()

Deprecated.

Compare getStatusCode() with StatusCode.ERROR

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.