Package io.opentelemetry.sdk.trace.data

Class ImmutableStatusData

java.lang.Object

io.opentelemetry.sdk.trace.data.ImmutableStatusData

All Implemented Interfaces:

StatusData

Direct Known Subclasses:

AutoValue_ImmutableStatusData

@Immutable
abstract class ImmutableStatusData
extends Object
implements StatusData

Defines the status of a Span by providing a standard StatusCode in conjunction with an optional descriptive message. Instances of Status are created by starting with the template for the appropriate StatusCode and supplementing it with additional information: Status.NOT_FOUND.withDescription("Could not find 'important_file.txt'");

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final StatusData	ERROR	The operation contains an error.
(package private) static final StatusData	OK	The operation has been validated by an Application developers or Operator to have completed successfully.
(package private) static final StatusData	UNSET	The default status.

Constructor Summary

Constructors

Constructor	Description
ImmutableStatusData()

Method Summary

Modifier and Type	Method	Description
(package private) static StatusData	create(StatusCode statusCode, String description)	Creates a derived instance of Status with the given description.
private static StatusData	createInternal(StatusCode statusCode, String description)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.sdk.trace.data.StatusData

getDescription, getStatusCode

Field Details

OK

static final StatusData OK

The operation has been validated by an Application developers or Operator to have completed successfully.

UNSET

static final StatusData UNSET

The default status.

ERROR

static final StatusData ERROR

The operation contains an error.

Constructor Details

ImmutableStatusData

ImmutableStatusData()

Method Details

create

static StatusData create(StatusCode statusCode,
 String description)

Creates a derived instance of Status with the given description.

Parameters:

description - the new description of the Status.

Returns:

The newly created Status with the given description.

createInternal

private static StatusData createInternal(StatusCode statusCode,
 String description)