Package io.opentelemetry.api.trace

Enum StatusCode

java.lang.Object

java.lang.Enum<StatusCode>

io.opentelemetry.api.trace.StatusCode

All Implemented Interfaces:

Serializable, Comparable<StatusCode>

public enum StatusCode
extends Enum<StatusCode>

The set of canonical status codes. If new codes are added over time they must choose a numerical value that does not collide with any previously used value.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	The operation contains an error.
OK	The operation has been validated by an Application developers or Operator to have completed successfully.
UNSET	The default status.

Method Summary

Modifier and Type	Method	Description
int	value()	Returns the numerical value of the code.
static StatusCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StatusCode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OK

public static final StatusCode OK

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

UNSET

public static final StatusCode UNSET

The default status.

ERROR

public static final StatusCode ERROR

The operation contains an error.

Method Detail

values

public static StatusCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StatusCode c : StatusCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StatusCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public int value()

Returns the numerical value of the code.

Returns:

the numerical value of the code.