Package io.opencensus.trace
Class Status
java.lang.Object
io.opencensus.trace.Status
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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The set of canonical status codes. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Status
The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.static final Status
Some entity that we attempted to create (e.g., file or directory) already exists.static final Status
The operation was cancelled (typically by the caller).private final Status.CanonicalCode
static final Status
Unrecoverable data loss or corruption.static final Status
Deadline expired before operation could complete.private final String
static final Status
Operation was rejected because the system is not in a state required for the operation's execution.static final Status
Internal errors.static final Status
Client specified an invalid argument.static final Status
Some requested entity (e.g., file or directory) was not found.static final Status
The operation completed successfully.static final Status
Operation was attempted past the valid range.static final Status
The caller does not have permission to execute the specified operation.static final Status
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.static final Status
The request does not have valid authentication credentials for the operation.static final Status
The service is currently unavailable.static final Status
Operation is not implemented or not supported/enabled in this service.static final Status
Unknown error. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Status
(Status.CanonicalCode canonicalCode, String description) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Equality on Statuses is not well defined.Returns the canonical status code.Returns the description of thisStatus
for human consumption.int
hashCode()
Hash codes on Statuses are not well defined.boolean
isOk()
Returnstrue
if thisStatus
is OK, i.e., not an error.toString()
withDescription
(String description) Creates a derived instance ofStatus
with the given description.
-
Field Details
-
STATUS_LIST
-
OK
The operation completed successfully.- Since:
- 0.5
-
CANCELLED
The operation was cancelled (typically by the caller).- Since:
- 0.5
-
UNKNOWN
Unknown error. SeeStatus.CanonicalCode.UNKNOWN
.- Since:
- 0.5
-
INVALID_ARGUMENT
Client specified an invalid argument. SeeStatus.CanonicalCode.INVALID_ARGUMENT
.- Since:
- 0.5
-
DEADLINE_EXCEEDED
Deadline expired before operation could complete. SeeStatus.CanonicalCode.DEADLINE_EXCEEDED
.- Since:
- 0.5
-
NOT_FOUND
Some requested entity (e.g., file or directory) was not found.- Since:
- 0.5
-
ALREADY_EXISTS
Some entity that we attempted to create (e.g., file or directory) already exists.- Since:
- 0.5
-
PERMISSION_DENIED
The caller does not have permission to execute the specified operation. SeeStatus.CanonicalCode.PERMISSION_DENIED
.- Since:
- 0.5
-
UNAUTHENTICATED
The request does not have valid authentication credentials for the operation.- Since:
- 0.5
-
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
Operation was rejected because the system is not in a state required for the operation's execution. SeeStatus.CanonicalCode.FAILED_PRECONDITION
.- Since:
- 0.5
-
ABORTED
The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. SeeStatus.CanonicalCode.ABORTED
.- Since:
- 0.5
-
OUT_OF_RANGE
Operation was attempted past the valid range. SeeStatus.CanonicalCode.OUT_OF_RANGE
.- Since:
- 0.5
-
UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.- Since:
- 0.5
-
INTERNAL
Internal errors. SeeStatus.CanonicalCode.INTERNAL
.- Since:
- 0.5
-
UNAVAILABLE
The service is currently unavailable. SeeStatus.CanonicalCode.UNAVAILABLE
.- Since:
- 0.5
-
DATA_LOSS
Unrecoverable data loss or corruption.- Since:
- 0.5
-
canonicalCode
-
description
-
-
Constructor Details
-
Status
-
-
Method Details
-
buildStatusList
-
withDescription
Creates a derived instance ofStatus
with the given description.- Parameters:
description
- the new description of theStatus
.- Returns:
- The newly created
Status
with the given description. - Since:
- 0.5
-
getCanonicalCode
Returns the canonical status code.- Returns:
- the canonical status code.
- Since:
- 0.5
-
getDescription
Returns the description of thisStatus
for human consumption.- Returns:
- the description of this
Status
. - Since:
- 0.5
-
isOk
public boolean isOk()Returnstrue
if thisStatus
is OK, i.e., not an error.- Returns:
true
if thisStatus
is OK.- Since:
- 0.5
-
equals
Equality on Statuses is not well defined. Instead, do comparison based on their CanonicalCode withgetCanonicalCode()
. The description of the Status is unlikely to be stable, and additional fields may be added to Status in the future. -
hashCode
public int hashCode()Hash codes on Statuses are not well defined. -
toString
-