summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/ExceptionFailure.html
blob: 418a450599f588c88af6bc7905b179963787c8e5 (plain) (tree)
1
2
3
4
5
6
7



                                                                                                      
                                                                                
                               
                                       





























                                                                                               

                                                                                                                                                  













































































































































































































































































































                                                                                                                                                                                                                                                                                                

                                                                                                                                                  








































                                                                                                                                                                                   
<!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 (version 1.7.0_51) on Wed Sep 16 15:55:11 PDT 2015 -->
<title>ExceptionFailure</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="ExceptionFailure";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../org/apache/spark/Dependency.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/ExecutorLostFailure.html" title="class in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/ExceptionFailure.html" target="_top">Frames</a></li>
<li><a href="ExceptionFailure.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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">org.apache.spark</div>
<h2 title="Class ExceptionFailure" class="title">Class ExceptionFailure</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ExceptionFailure</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../org/apache/spark/TaskEndReason.html" title="interface in org.apache.spark">TaskEndReason</a>, <a href="../../../org/apache/spark/TaskFailedReason.html" title="interface in org.apache.spark">TaskFailedReason</a>, scala.Equals, scala.Product</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ExceptionFailure</span>
extends java.lang.Object
implements <a href="../../../org/apache/spark/TaskFailedReason.html" title="interface in org.apache.spark">TaskFailedReason</a>, scala.Product, scala.Serializable</pre>
<div class="block">:: DeveloperApi ::
 Task failed due to a runtime exception. This is the most common failure case and also captures
 user program exceptions.
 <p>
 <code>stackTrace</code> contains the stack trace of the exception itself. It still exists for backward
 compatibility. It's better to use <code>this(e: Throwable, metrics: Option[TaskMetrics])</code> to
 create <code>ExceptionFailure</code> as it will handle the backward compatibility properly.
 <p>
 <code>fullStackTrace</code> is a better representation of the stack trace because it contains the whole
 stack trace including the exception and its causes
 <p>
 <code>exception</code> is the actual exception that caused the task to fail. It may be <code>None</code> in
 the case that the exception is not in fact serializable. If a task fails more than
 once (due to retries), <code>exception</code> is that one that caused the last failure.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#org.apache.spark.ExceptionFailure">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#ExceptionFailure(java.lang.String, java.lang.String, java.lang.StackTraceElement[], java.lang.String, scala.Option, scala.Option)">ExceptionFailure</a></strong>(java.lang.String&nbsp;className,
                java.lang.String&nbsp;description,
                java.lang.StackTraceElement[]&nbsp;stackTrace,
                java.lang.String&nbsp;fullStackTrace,
                scala.Option&lt;org.apache.spark.executor.TaskMetrics&gt;&nbsp;metrics,
                scala.Option&lt;org.apache.spark.ThrowableSerializationWrapper&gt;&nbsp;exceptionWrapper)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#className()">className</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#description()">description</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.Option&lt;java.lang.Throwable&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#exception()">exception</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#fullStackTrace()">fullStackTrace</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.Option&lt;org.apache.spark.executor.TaskMetrics&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#metrics()">metrics</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.StackTraceElement[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#stackTrace()">stackTrace</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ExceptionFailure.html#toErrorString()">toErrorString</a></strong>()</code>
<div class="block">Error message displayed in the web UI.</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_scala.Product">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;scala.Product</h3>
<code>productArity, productElement, productIterator, productPrefix</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_scala.Equals">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;scala.Equals</h3>
<code>canEqual, equals</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="ExceptionFailure(java.lang.String, java.lang.String, java.lang.StackTraceElement[], java.lang.String, scala.Option, scala.Option)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ExceptionFailure</h4>
<pre>public&nbsp;ExceptionFailure(java.lang.String&nbsp;className,
                java.lang.String&nbsp;description,
                java.lang.StackTraceElement[]&nbsp;stackTrace,
                java.lang.String&nbsp;fullStackTrace,
                scala.Option&lt;org.apache.spark.executor.TaskMetrics&gt;&nbsp;metrics,
                scala.Option&lt;org.apache.spark.ThrowableSerializationWrapper&gt;&nbsp;exceptionWrapper)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="className()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>className</h4>
<pre>public&nbsp;java.lang.String&nbsp;className()</pre>
</li>
</ul>
<a name="description()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public&nbsp;java.lang.String&nbsp;description()</pre>
</li>
</ul>
<a name="stackTrace()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stackTrace</h4>
<pre>public&nbsp;java.lang.StackTraceElement[]&nbsp;stackTrace()</pre>
</li>
</ul>
<a name="fullStackTrace()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fullStackTrace</h4>
<pre>public&nbsp;java.lang.String&nbsp;fullStackTrace()</pre>
</li>
</ul>
<a name="metrics()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>metrics</h4>
<pre>public&nbsp;scala.Option&lt;org.apache.spark.executor.TaskMetrics&gt;&nbsp;metrics()</pre>
</li>
</ul>
<a name="exception()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exception</h4>
<pre>public&nbsp;scala.Option&lt;java.lang.Throwable&gt;&nbsp;exception()</pre>
</li>
</ul>
<a name="toErrorString()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toErrorString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toErrorString()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/TaskFailedReason.html#toErrorString()">TaskFailedReason</a></code></strong></div>
<div class="block">Error message displayed in the web UI.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/TaskFailedReason.html#toErrorString()">toErrorString</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/TaskFailedReason.html" title="interface in org.apache.spark">TaskFailedReason</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../org/apache/spark/Dependency.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/ExecutorLostFailure.html" title="class in org.apache.spark"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/spark/ExceptionFailure.html" target="_top">Frames</a></li>
<li><a href="ExceptionFailure.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All 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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../lib/api-javadocs.js"></script></body>
</html>