Class Status

java.lang.Object
io.opencensus.trace.Status
@Immutable public final class Status extends Object
Defines the status of a Span by providing a standard Status.CanonicalCode in conjunction with an optional descriptive message. Instances of Status are created by starting with the template for the appropriate Status.CanonicalCode and supplementing it with additional information: Status.NOT_FOUND.withDescription("Could not find 'important_file.txt'");
Since:
0.5

  • Field Details

    • STATUS_LIST

      private static final List<Status> STATUS_LIST

    • OK

      public static final Status OK
      The operation completed successfully.
      Since:
      0.5

    • CANCELLED

      public static final Status CANCELLED
      The operation was cancelled (typically by the caller).
      Since:
      0.5

    • UNKNOWN

      public static final Status UNKNOWN
      Unknown error. See Status.CanonicalCode.UNKNOWN.
      Since:
      0.5

    • INVALID_ARGUMENT

      public static final Status INVALID_ARGUMENT
      Client specified an invalid argument. See Status.CanonicalCode.INVALID_ARGUMENT.
      Since:
      0.5

    • DEADLINE_EXCEEDED

      public static final Status DEADLINE_EXCEEDED
      Deadline expired before operation could complete. See Status.CanonicalCode.DEADLINE_EXCEEDED.
      Since:
      0.5

    • NOT_FOUND

      public static final Status NOT_FOUND
      Some requested entity (e.g., file or directory) was not found.
      Since:
      0.5

    • ALREADY_EXISTS

      public static final Status ALREADY_EXISTS
      Some entity that we attempted to create (e.g., file or directory) already exists.
      Since:
      0.5

    • PERMISSION_DENIED

      public static final Status PERMISSION_DENIED
      The caller does not have permission to execute the specified operation. See Status.CanonicalCode.PERMISSION_DENIED.
      Since:
      0.5

    • UNAUTHENTICATED

      public static final Status UNAUTHENTICATED
      The request does not have valid authentication credentials for the operation.
      Since:
      0.5

    • RESOURCE_EXHAUSTED

      public static final Status RESOURCE_EXHAUSTED
      Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
      Since:
      0.5

    • FAILED_PRECONDITION

      public static final Status FAILED_PRECONDITION
      Operation was rejected because the system is not in a state required for the operation's execution. See Status.CanonicalCode.FAILED_PRECONDITION.
      Since:
      0.5

    • ABORTED

      public static final Status ABORTED
      The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. See Status.CanonicalCode.ABORTED.
      Since:
      0.5

    • OUT_OF_RANGE

      public static final Status OUT_OF_RANGE
      Operation was attempted past the valid range. See Status.CanonicalCode.OUT_OF_RANGE.
      Since:
      0.5

    • UNIMPLEMENTED

      public static final Status UNIMPLEMENTED
      Operation is not implemented or not supported/enabled in this service.
      Since:
      0.5

    • INTERNAL

      public static final Status INTERNAL
      Internal errors. See Status.CanonicalCode.INTERNAL.
      Since:
      0.5

    • UNAVAILABLE

      public static final Status UNAVAILABLE
      The service is currently unavailable. See Status.CanonicalCode.UNAVAILABLE.
      Since:
      0.5

    • DATA_LOSS

      public static final Status DATA_LOSS
      Unrecoverable data loss or corruption.
      Since:
      0.5

    • canonicalCode

      private final Status.CanonicalCode canonicalCode

    • description

      @Nullable private final String description

  • Constructor Details

  • Method Details

    • buildStatusList

      private static List<Status> buildStatusList()

    • withDescription

      public Status withDescription(@Nullable 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.
      Since:
      0.5

    • getCanonicalCode

      public Status.CanonicalCode getCanonicalCode()
      Returns the canonical status code.
      Returns:
      the canonical status code.
      Since:
      0.5

    • getDescription

      @Nullable public String getDescription()
      Returns the description of this Status for human consumption.
      Returns:
      the description of this Status.
      Since:
      0.5

    • isOk

      public boolean isOk()
      Returns true if this Status is OK, i.e., not an error.
      Returns:
      true if this Status is OK.
      Since:
      0.5

    • equals

      public boolean equals(@Nullable Object obj)
      Equality on Statuses is not well defined. Instead, do comparison based on their CanonicalCode with getCanonicalCode(). The description of the Status is unlikely to be stable, and additional fields may be added to Status in the future.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Hash codes on Statuses are not well defined.
      Overrides:
      hashCode in class Object
      See Also:

    • toString

      public String toString()
      Overrides:
      toString in class Object