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/BlankSpan.html

672 lines
37 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>BlankSpan (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="BlankSpan (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,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":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/AttributeValue.Type.html" title="enum in openconsensus.trace"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../openconsensus/trace/Event.html" title="class in openconsensus.trace"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openconsensus/trace/BlankSpan.html" target="_top">Frames</a></li>
<li><a href="BlankSpan.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>Nested&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 BlankSpan" class="title">Class BlankSpan</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.BlankSpan</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></dd>
</dl>
<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">BlankSpan</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>
implements <a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></pre>
<div class="block">The <code>BlankSpan</code> is a singleton class, which is the default <a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace"><code>Span</code></a> that is used when
no <code>Span</code> implementation is available. All operations are no-op.
<p>Used also to stop tracing, see <a href="../../openconsensus/trace/Tracer.html#withSpan-openconsensus.trace.Span-"><code>Tracer.withSpan(openconsensus.trace.Span)</code></a>.</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.openconsensus.trace.Span">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;openconsensus.trace.<a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></h3>
<code><a href="../../openconsensus/trace/Span.Builder.html" title="interface in openconsensus.trace">Span.Builder</a>, <a href="../../openconsensus/trace/Span.Kind.html" title="enum in openconsensus.trace">Span.Kind</a></code></li>
</ul>
</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/Span.html" title="interface in openconsensus.trace">Span</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#INSTANCE">INSTANCE</a></span></code>
<div class="block">Singleton instance of this class.</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#addEvent-openconsensus.trace.Event-">addEvent</a></span>(<a href="../../openconsensus/trace/Event.html" title="class in openconsensus.trace">Event</a>&nbsp;event)</code>
<div class="block">Adds an event to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#addEvent-java.lang.String-">addEvent</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;name)</code>
<div class="block">Adds an event to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#addEvent-java.lang.String-java.util.Map-">addEvent</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;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../openconsensus/trace/AttributeValue.html" title="class in openconsensus.trace">AttributeValue</a>&gt;&nbsp;attributes)</code>
<div class="block">Adds an event to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#addLink-openconsensus.trace.Link-">addLink</a></span>(<a href="../../openconsensus/trace/Link.html" title="class in openconsensus.trace">Link</a>&nbsp;link)</code>
<div class="block">Adds a <a href="../../openconsensus/trace/Link.html" title="class in openconsensus.trace"><code>Link</code></a> to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#end--">end</a></span>()</code>
<div class="block">Marks the end of <code>Span</code> execution with the default options.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../openconsensus/trace/SpanContext.html" title="class in openconsensus.trace">SpanContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#getContext--">getContext</a></span>()</code>
<div class="block">Returns the <code>SpanContext</code> associated with this <code>Span</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#isRecordingEvents--">isRecordingEvents</a></span>()</code>
<div class="block">Returns <code>true</code> if this <code>Span</code> records events (e.g, <a href="../../openconsensus/trace/Span.html#addEvent-java.lang.String-"><code>Span.addEvent(String)</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#setAttribute-java.lang.String-openconsensus.trace.AttributeValue-">setAttribute</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;key,
<a href="../../openconsensus/trace/AttributeValue.html" title="class in openconsensus.trace">AttributeValue</a>&nbsp;value)</code>
<div class="block">Sets an attribute to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#setAttribute-java.lang.String-boolean-">setAttribute</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;key,
boolean&nbsp;value)</code>
<div class="block">Sets an attribute to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#setAttribute-java.lang.String-double-">setAttribute</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;key,
double&nbsp;value)</code>
<div class="block">Sets an attribute to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#setAttribute-java.lang.String-long-">setAttribute</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;key,
long&nbsp;value)</code>
<div class="block">Sets an attribute to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#setAttribute-java.lang.String-java.lang.String-">setAttribute</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;key,
<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;value)</code>
<div class="block">Sets an attribute to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#setStatus-openconsensus.trace.Status-">setStatus</a></span>(<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a>&nbsp;status)</code>
<div class="block">Sets the <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace"><code>Status</code></a> to the <code>Span</code>.</div>
</td>
</tr>
<tr id="i13" 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/BlankSpan.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../openconsensus/trace/BlankSpan.html#updateName-java.lang.String-">updateName</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;name)</code>
<div class="block">Updates the <code>Span</code> name.</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#equals-java.lang.Object-" title="class or interface in java.lang">equals</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#hashCode--" title="class or interface in java.lang">hashCode</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="INSTANCE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>INSTANCE</h4>
<pre>public static final&nbsp;<a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a> INSTANCE</pre>
<div class="block">Singleton instance of this class.</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="setAttribute-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;void&nbsp;setAttribute(<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;key,
<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;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-java.lang.String-">Span</a></code></span></div>
<div class="block">Sets an attribute to the <code>Span</code>. If the <code>Span</code> previously contained a mapping for
the key, the old value is replaced by the specified value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-java.lang.String-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key for this attribute.</dd>
<dd><code>value</code> - the value for this attribute.</dd>
</dl>
</li>
</ul>
<a name="setAttribute-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;void&nbsp;setAttribute(<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;key,
long&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-long-">Span</a></code></span></div>
<div class="block">Sets an attribute to the <code>Span</code>. If the <code>Span</code> previously contained a mapping for
the key, the old value is replaced by the specified value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-long-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key for this attribute.</dd>
<dd><code>value</code> - the value for this attribute.</dd>
</dl>
</li>
</ul>
<a name="setAttribute-java.lang.String-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;void&nbsp;setAttribute(<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;key,
double&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-double-">Span</a></code></span></div>
<div class="block">Sets an attribute to the <code>Span</code>. If the <code>Span</code> previously contained a mapping for
the key, the old value is replaced by the specified value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-double-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key for this attribute.</dd>
<dd><code>value</code> - the value for this attribute.</dd>
</dl>
</li>
</ul>
<a name="setAttribute-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;void&nbsp;setAttribute(<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;key,
boolean&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-boolean-">Span</a></code></span></div>
<div class="block">Sets an attribute to the <code>Span</code>. If the <code>Span</code> previously contained a mapping for
the key, the old value is replaced by the specified value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-boolean-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key for this attribute.</dd>
<dd><code>value</code> - the value for this attribute.</dd>
</dl>
</li>
</ul>
<a name="setAttribute-java.lang.String-openconsensus.trace.AttributeValue-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;void&nbsp;setAttribute(<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;key,
<a href="../../openconsensus/trace/AttributeValue.html" title="class in openconsensus.trace">AttributeValue</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-openconsensus.trace.AttributeValue-">Span</a></code></span></div>
<div class="block">Sets an attribute to the <code>Span</code>. If the <code>Span</code> previously contained a mapping for
the key, the old value is replaced by the specified value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#setAttribute-java.lang.String-openconsensus.trace.AttributeValue-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key for this attribute.</dd>
<dd><code>value</code> - the value for this attribute.</dd>
</dl>
</li>
</ul>
<a name="addEvent-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEvent</h4>
<pre>public&nbsp;void&nbsp;addEvent(<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;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#addEvent-java.lang.String-">Span</a></code></span></div>
<div class="block">Adds an event to the <code>Span</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#addEvent-java.lang.String-">addEvent</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the event.</dd>
</dl>
</li>
</ul>
<a name="addEvent-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEvent</h4>
<pre>public&nbsp;void&nbsp;addEvent(<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;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<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>,<a href="../../openconsensus/trace/AttributeValue.html" title="class in openconsensus.trace">AttributeValue</a>&gt;&nbsp;attributes)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#addEvent-java.lang.String-java.util.Map-">Span</a></code></span></div>
<div class="block">Adds an event to the <code>Span</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#addEvent-java.lang.String-java.util.Map-">addEvent</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the event.</dd>
<dd><code>attributes</code> - the attributes that will be added; these are associated with this event, not
the <code>Span</code> as for <code>setAttributes()</code>.</dd>
</dl>
</li>
</ul>
<a name="addEvent-openconsensus.trace.Event-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEvent</h4>
<pre>public&nbsp;void&nbsp;addEvent(<a href="../../openconsensus/trace/Event.html" title="class in openconsensus.trace">Event</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#addEvent-openconsensus.trace.Event-">Span</a></code></span></div>
<div class="block">Adds an event to the <code>Span</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#addEvent-openconsensus.trace.Event-">addEvent</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the event to add.</dd>
</dl>
</li>
</ul>
<a name="addLink-openconsensus.trace.Link-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLink</h4>
<pre>public&nbsp;void&nbsp;addLink(<a href="../../openconsensus/trace/Link.html" title="class in openconsensus.trace">Link</a>&nbsp;link)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#addLink-openconsensus.trace.Link-">Span</a></code></span></div>
<div class="block">Adds a <a href="../../openconsensus/trace/Link.html" title="class in openconsensus.trace"><code>Link</code></a> to the <code>Span</code>.
<p>Used (for example) in batching operations, where a single batch handler processes multiple
requests from different traces.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#addLink-openconsensus.trace.Link-">addLink</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>link</code> - the link to add.</dd>
</dl>
</li>
</ul>
<a name="setStatus-openconsensus.trace.Status-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatus</h4>
<pre>public&nbsp;void&nbsp;setStatus(<a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace">Status</a>&nbsp;status)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#setStatus-openconsensus.trace.Status-">Span</a></code></span></div>
<div class="block">Sets the <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace"><code>Status</code></a> to the <code>Span</code>.
<p>If used, this will override the default <code>Span</code> status. Default is <a href="../../openconsensus/trace/Status.html#OK"><code>Status.OK</code></a>.
<p>Only the value of the last call will be recorded, and implementations are free to ignore
previous calls.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#setStatus-openconsensus.trace.Status-">setStatus</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>status</code> - the <a href="../../openconsensus/trace/Status.html" title="class in openconsensus.trace"><code>Status</code></a> to set.</dd>
</dl>
</li>
</ul>
<a name="updateName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateName</h4>
<pre>public&nbsp;void&nbsp;updateName(<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;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#updateName-java.lang.String-">Span</a></code></span></div>
<div class="block">Updates the <code>Span</code> name.
<p>If used, this will override the name provided via <code>Span.Builder</code>.
<p>Upon this update, any sampling behavior based on <code>Span</code> name will depend on the
implementation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#updateName-java.lang.String-">updateName</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the <code>Span</code> name.</dd>
</dl>
</li>
</ul>
<a name="end--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>end</h4>
<pre>public&nbsp;void&nbsp;end()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#end--">Span</a></code></span></div>
<div class="block">Marks the end of <code>Span</code> execution with the default options.
<p>Only the timing of the first end call for a given <code>Span</code> will be recorded, and
implementations are free to ignore all further calls.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#end--">end</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
</dl>
</li>
</ul>
<a name="getContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre>public&nbsp;<a href="../../openconsensus/trace/SpanContext.html" title="class in openconsensus.trace">SpanContext</a>&nbsp;getContext()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#getContext--">Span</a></code></span></div>
<div class="block">Returns the <code>SpanContext</code> associated with this <code>Span</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#getContext--">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>SpanContext</code> associated with this <code>Span</code>.</dd>
</dl>
</li>
</ul>
<a name="isRecordingEvents--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRecordingEvents</h4>
<pre>public&nbsp;boolean&nbsp;isRecordingEvents()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../openconsensus/trace/Span.html#isRecordingEvents--">Span</a></code></span></div>
<div class="block">Returns <code>true</code> if this <code>Span</code> records events (e.g, <a href="../../openconsensus/trace/Span.html#addEvent-java.lang.String-"><code>Span.addEvent(String)</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../openconsensus/trace/Span.html#isRecordingEvents--">isRecordingEvents</a></code>&nbsp;in interface&nbsp;<code><a href="../../openconsensus/trace/Span.html" title="interface in openconsensus.trace">Span</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this <code>Span</code> records events.</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/AttributeValue.Type.html" title="enum in openconsensus.trace"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../openconsensus/trace/Event.html" title="class in openconsensus.trace"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?openconsensus/trace/BlankSpan.html" target="_top">Frames</a></li>
<li><a href="BlankSpan.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>Nested&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