open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
opentelemetry-java/docs/openconsensus/trace/Status.html

777 lines
35 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Thu Apr 25 10:43:39 PDT 2019 -->
<title>Status (openconsensus-api 0.1.0-SNAPSHOT API)</title>
<meta name="date" content="2019-04-25">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Status (openconsensus-api 0.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../openconsensus/trace/SpanId.html" title="class in openconsensus.trace"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../openconsensus/trace/Status.CanonicalCode.html" title="enum in openconsensus.trace"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openconsensus/trace/Status.html" target="_top">Frames</a></li>
<li><a href="Status.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">openconsensus.trace</div>
<h2 title="Class Status" class="title">Class Status</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>openconsensus.trace.Status</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/concurrent.Immutable.html?is-external=true" title="class or interface in javax.annotation">@Immutable</a>
public final class <span class="typeNameLabel">Status</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Defines the status of a <a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace"><code>Span</code></a> by providing a standard <a href="../../openconsensus/trace/Status.CanonicalCode.html" title="enum in openconsensus.trace"><code>Status.CanonicalCode</code></a> in conjunction
with an optional descriptive message. Instances of <code>Status</code> are created by starting with
the template for the appropriate <a href="../../openconsensus/trace/Status.CanonicalCode.html" title="enum in openconsensus.trace"><code>Status.CanonicalCode</code></a> and supplementing it with
additional information: <code>Status.NOT_FOUND.withDescription("Could not find
'important_file.txt'");</code></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.CanonicalCode.html" title="enum in openconsensus.trace">Status.CanonicalCode</a></span></code>
<div class="block">The set of canonical status codes.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#ABORTED">ABORTED</a></span></code>
<div class="block">The operation was aborted, typically due to a concurrency issue like sequencer check failures,
transaction aborts, etc.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#ALREADY_EXISTS">ALREADY_EXISTS</a></span></code>
<div class="block">Some entity that we attempted to create (e.g., file or directory) already exists.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#CANCELLED">CANCELLED</a></span></code>
<div class="block">The operation was cancelled (typically by the caller).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#DATA_LOSS">DATA_LOSS</a></span></code>
<div class="block">Unrecoverable data loss or corruption.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#DEADLINE_EXCEEDED">DEADLINE_EXCEEDED</a></span></code>
<div class="block">Deadline expired before operation could complete.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#FAILED_PRECONDITION">FAILED_PRECONDITION</a></span></code>
<div class="block">Operation was rejected because the system is not in a state required for the operation's
execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#INTERNAL">INTERNAL</a></span></code>
<div class="block">Internal errors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#INVALID_ARGUMENT">INVALID_ARGUMENT</a></span></code>
<div class="block">Client specified an invalid argument.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#NOT_FOUND">NOT_FOUND</a></span></code>
<div class="block">Some requested entity (e.g., file or directory) was not found.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#OK">OK</a></span></code>
<div class="block">The operation completed successfully.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#OUT_OF_RANGE">OUT_OF_RANGE</a></span></code>
<div class="block">Operation was attempted past the valid range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#PERMISSION_DENIED">PERMISSION_DENIED</a></span></code>
<div class="block">The caller does not have permission to execute the specified operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#RESOURCE_EXHAUSTED">RESOURCE_EXHAUSTED</a></span></code>
<div class="block">Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system
is out of space.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#UNAUTHENTICATED">UNAUTHENTICATED</a></span></code>
<div class="block">The request does not have valid authentication credentials for the operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#UNAVAILABLE">UNAVAILABLE</a></span></code>
<div class="block">The service is currently unavailable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#UNIMPLEMENTED">UNIMPLEMENTED</a></span></code>
<div class="block">Operation is not implemented or not supported/enabled in this service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#UNKNOWN">UNKNOWN</a></span></code>
<div class="block">Unknown error.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>
<div class="block">Equality on Statuses is not well defined.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../openconsensus/trace/Status.CanonicalCode.html" title="enum in openconsensus.trace">Status.CanonicalCode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#getCanonicalCode--">getCanonicalCode</a></span>()</code>
<div class="block">Returns the canonical status code.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#getDescription--">getDescription</a></span>()</code>
<div class="block">Returns the description of this <code>Status</code> for human consumption.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Hash codes on Statuses are not well defined.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#isOk--">isOk</a></span>()</code>
<div class="block">Returns <code>true</code> if this <code>Status</code> is OK, i.e., not an error.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/Status.html#withDescription-java.lang.String-">withDescription</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;description)</code>
<div class="block">Creates a derived instance of <code>Status</code> with the given description.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="OK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OK</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> OK</pre>
<div class="block">The operation completed successfully.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="CANCELLED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CANCELLED</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> CANCELLED</pre>
<div class="block">The operation was cancelled (typically by the caller).</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="UNKNOWN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNKNOWN</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> UNKNOWN</pre>
<div class="block">Unknown error. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#UNKNOWN"><code>Status.CanonicalCode.UNKNOWN</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="INVALID_ARGUMENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVALID_ARGUMENT</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> INVALID_ARGUMENT</pre>
<div class="block">Client specified an invalid argument. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#INVALID_ARGUMENT"><code>Status.CanonicalCode.INVALID_ARGUMENT</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="DEADLINE_EXCEEDED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEADLINE_EXCEEDED</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> DEADLINE_EXCEEDED</pre>
<div class="block">Deadline expired before operation could complete. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#DEADLINE_EXCEEDED"><code>Status.CanonicalCode.DEADLINE_EXCEEDED</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="NOT_FOUND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NOT_FOUND</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> NOT_FOUND</pre>
<div class="block">Some requested entity (e.g., file or directory) was not found.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="ALREADY_EXISTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ALREADY_EXISTS</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> ALREADY_EXISTS</pre>
<div class="block">Some entity that we attempted to create (e.g., file or directory) already exists.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="PERMISSION_DENIED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERMISSION_DENIED</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> PERMISSION_DENIED</pre>
<div class="block">The caller does not have permission to execute the specified operation. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#PERMISSION_DENIED"><code>Status.CanonicalCode.PERMISSION_DENIED</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="UNAUTHENTICATED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNAUTHENTICATED</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> UNAUTHENTICATED</pre>
<div class="block">The request does not have valid authentication credentials for the operation.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="RESOURCE_EXHAUSTED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RESOURCE_EXHAUSTED</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> RESOURCE_EXHAUSTED</pre>
<div class="block">Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system
is out of space.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="FAILED_PRECONDITION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FAILED_PRECONDITION</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> FAILED_PRECONDITION</pre>
<div class="block">Operation was rejected because the system is not in a state required for the operation's
execution. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#FAILED_PRECONDITION"><code>Status.CanonicalCode.FAILED_PRECONDITION</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="ABORTED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ABORTED</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> ABORTED</pre>
<div class="block">The operation was aborted, typically due to a concurrency issue like sequencer check failures,
transaction aborts, etc. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#ABORTED"><code>Status.CanonicalCode.ABORTED</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="OUT_OF_RANGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OUT_OF_RANGE</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> OUT_OF_RANGE</pre>
<div class="block">Operation was attempted past the valid range. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#OUT_OF_RANGE"><code>Status.CanonicalCode.OUT_OF_RANGE</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="UNIMPLEMENTED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNIMPLEMENTED</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> UNIMPLEMENTED</pre>
<div class="block">Operation is not implemented or not supported/enabled in this service.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="INTERNAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INTERNAL</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> INTERNAL</pre>
<div class="block">Internal errors. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#INTERNAL"><code>Status.CanonicalCode.INTERNAL</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="UNAVAILABLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNAVAILABLE</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> UNAVAILABLE</pre>
<div class="block">The service is currently unavailable. See <a href="../../openconsensus/trace/Status.CanonicalCode.html#UNAVAILABLE"><code>Status.CanonicalCode.UNAVAILABLE</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="DATA_LOSS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DATA_LOSS</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a> DATA_LOSS</pre>
<div class="block">Unrecoverable data loss or corruption.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="withDescription-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDescription</h4>
<pre>public&nbsp;<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a>&nbsp;withDescription(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;description)</pre>
<div class="block">Creates a derived instance of <code>Status</code> with the given description.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>description</code> - the new description of the <code>Status</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created <code>Status</code> with the given description.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="getCanonicalCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCanonicalCode</h4>
<pre>public&nbsp;<a href="../../openconsensus/trace/Status.CanonicalCode.html" title="enum in openconsensus.trace">Status.CanonicalCode</a>&nbsp;getCanonicalCode()</pre>
<div class="block">Returns the canonical status code.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the canonical status code.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDescription()</pre>
<div class="block">Returns the description of this <code>Status</code> for human consumption.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the description of this <code>Status</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="isOk--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOk</h4>
<pre>public&nbsp;boolean&nbsp;isOk()</pre>
<div class="block">Returns <code>true</code> if this <code>Status</code> is OK, i.e., not an error.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this <code>Status</code> is OK.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.1.0</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html?is-external=true" title="class or interface in javax.annotation">@Nullable</a>
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<div class="block">Equality on Statuses is not well defined. Instead, do comparison based on their CanonicalCode
with <a href="../../openconsensus/trace/Status.html#getCanonicalCode--"><code>getCanonicalCode()</code></a>. The description of the Status is unlikely to be stable, and
additional fields may be added to Status in the future.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Hash codes on Statuses are not well defined.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../openconsensus/trace/Status.html#equals-java.lang.Object-"><code>equals(java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../openconsensus/trace/SpanId.html" title="class in openconsensus.trace"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../openconsensus/trace/Status.CanonicalCode.html" title="enum in openconsensus.trace"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openconsensus/trace/Status.html" target="_top">Frames</a></li>
<li><a href="Status.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink