Package io.opentelemetry.sdk.trace.data

Interface StatusData

All Known Implementing Classes:
AutoValue_ImmutableStatusData, ImmutableStatusData
@Immutable public interface StatusData
Defines the status of a Span by providing a standard StatusCode in conjunction with an optional descriptive message.

  • Method Details

    • 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(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

      StatusCode getStatusCode()
      Returns the status code.

    • getDescription

      String getDescription()
      Returns the description of this Status for human consumption.
      Returns:
      the description of this Status.