| <!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_312) on Mon Jul 11 16:23:57 UTC 2022 --> |
| <title>ComplexFutureAction (Spark 3.2.2 JavaDoc)</title> |
| <meta name="date" content="2022-07-11"> |
| <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="ComplexFutureAction (Spark 3.2.2 JavaDoc)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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="../../../org/apache/spark/CleanupTaskWeakReference.html" title="class in org.apache.spark"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/spark/ContextAwareIterator.html" title="class in org.apache.spark"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/spark/ComplexFutureAction.html" target="_top">Frames</a></li> |
| <li><a href="ComplexFutureAction.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 ComplexFutureAction" class="title">Class ComplexFutureAction<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.spark.ComplexFutureAction<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><T>, scala.concurrent.Awaitable<T>, scala.concurrent.Future<T></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ComplexFutureAction<T></span> |
| extends Object |
| implements <a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><T></pre> |
| <div class="block">A <a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark"><code>FutureAction</code></a> for actions that could trigger multiple Spark jobs. Examples include take, |
| takeSample. Cancellation works by setting the cancelled flag to true and cancelling any pending |
| jobs.</div> |
| </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.scala.concurrent.Future"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface scala.concurrent.Future</h3> |
| <code>scala.concurrent.Future.InternalCallbackExecutor$, scala.concurrent.Future.never$</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#ComplexFutureAction-scala.Function1-">ComplexFutureAction</a></span>(scala.Function1<<a href="../../../org/apache/spark/JobSubmitter.html" title="interface in org.apache.spark">JobSubmitter</a>,scala.concurrent.Future<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>> run)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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="../../../org/apache/spark/ComplexFutureAction.html#cancel--">cancel</a></span>()</code> |
| <div class="block">Cancels the execution of this action.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#isCancelled--">isCancelled</a></span>()</code> |
| <div class="block">Returns whether the action has been cancelled.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#isCompleted--">isCompleted</a></span>()</code> |
| <div class="block">Returns whether the action has already been completed with a value or an exception.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>scala.collection.Seq<Object></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#jobIds--">jobIds</a></span>()</code> |
| <div class="block">Returns the job IDs run by the underlying async operation.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><U> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#onComplete-scala.Function1-scala.concurrent.ExecutionContext-">onComplete</a></span>(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>,U> func, |
| scala.concurrent.ExecutionContext executor)</code> |
| <div class="block">When this action is completed, either through an exception, or a value, applies the provided |
| function.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/spark/ComplexFutureAction.html" title="class in org.apache.spark">ComplexFutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#ready-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-">ready</a></span>(scala.concurrent.duration.Duration atMost, |
| scala.concurrent.CanAwait permit)</code> |
| <div class="block">Blocks until this action completes.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#result-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-">result</a></span>(scala.concurrent.duration.Duration atMost, |
| scala.concurrent.CanAwait permit)</code> |
| <div class="block">Awaits and returns the result (of type T) of this action.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><S> scala.concurrent.Future<S></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#transform-scala.Function1-scala.concurrent.ExecutionContext-">transform</a></span>(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>,scala.util.Try<S>> f, |
| scala.concurrent.ExecutionContext e)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><S> scala.concurrent.Future<S></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#transformWith-scala.Function1-scala.concurrent.ExecutionContext-">transformWith</a></span>(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>,scala.concurrent.Future<S>> f, |
| scala.concurrent.ExecutionContext e)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>scala.Option<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/ComplexFutureAction.html#value--">value</a></span>()</code> |
| <div class="block">The value of this Future.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class Object</h3> |
| <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.FutureAction"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.<a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a></h3> |
| <code><a href="../../../org/apache/spark/FutureAction.html#get--">get</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.scala.concurrent.Future"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface scala.concurrent.Future</h3> |
| <code>$init$, andThen, apply, collect, failed, fallbackTo, filter, find, find, firstCompletedOf, flatMap, flatten, fold, foldLeft, foreach, fromTry, map, mapTo, onFailure, onSuccess, recover, recoverWith, reduce, reduceLeft, sequence, successful, transform, traverse, unit, withFilter, zip, zipWith</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="ComplexFutureAction-scala.Function1-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ComplexFutureAction</h4> |
| <pre>public ComplexFutureAction(scala.Function1<<a href="../../../org/apache/spark/JobSubmitter.html" title="interface in org.apache.spark">JobSubmitter</a>,scala.concurrent.Future<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>> run)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="cancel--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre>public void cancel()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#cancel--">FutureAction</a></code></span></div> |
| <div class="block">Cancels the execution of this action.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#cancel--">cancel</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCancelled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCancelled</h4> |
| <pre>public boolean isCancelled()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#isCancelled--">FutureAction</a></code></span></div> |
| <div class="block">Returns whether the action has been cancelled.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#isCancelled--">isCancelled</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCompleted--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCompleted</h4> |
| <pre>public boolean isCompleted()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#isCompleted--">FutureAction</a></code></span></div> |
| <div class="block">Returns whether the action has already been completed with a value or an exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#isCompleted--">isCompleted</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>isCompleted</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="jobIds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>jobIds</h4> |
| <pre>public scala.collection.Seq<Object> jobIds()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#jobIds--">FutureAction</a></code></span></div> |
| <div class="block">Returns the job IDs run by the underlying async operation. |
| <p> |
| This returns the current snapshot of the job list. Certain operations may run multiple |
| jobs, so multiple calls to this method may return different lists.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#jobIds--">jobIds</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onComplete-scala.Function1-scala.concurrent.ExecutionContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onComplete</h4> |
| <pre>public <U> void onComplete(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>,U> func, |
| scala.concurrent.ExecutionContext executor)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#onComplete-scala.Function1-scala.concurrent.ExecutionContext-">FutureAction</a></code></span></div> |
| <div class="block">When this action is completed, either through an exception, or a value, applies the provided |
| function.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#onComplete-scala.Function1-scala.concurrent.ExecutionContext-">onComplete</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>onComplete</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>func</code> - (undocumented)</dd> |
| <dd><code>executor</code> - (undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ready-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ready</h4> |
| <pre>public <a href="../../../org/apache/spark/ComplexFutureAction.html" title="class in org.apache.spark">ComplexFutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>> ready(scala.concurrent.duration.Duration atMost, |
| scala.concurrent.CanAwait permit) |
| throws InterruptedException, |
| java.util.concurrent.TimeoutException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#ready-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-">FutureAction</a></code></span></div> |
| <div class="block">Blocks until this action completes. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#ready-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-">ready</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>ready</code> in interface <code>scala.concurrent.Awaitable<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>atMost</code> - maximum wait time, which may be negative (no waiting is done), Duration.Inf |
| for unbounded waiting, or a finite positive duration</dd> |
| <dd><code>permit</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this FutureAction</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>InterruptedException</code></dd> |
| <dd><code>java.util.concurrent.TimeoutException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="result-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>result</h4> |
| <pre>public <a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a> result(scala.concurrent.duration.Duration atMost, |
| scala.concurrent.CanAwait permit) |
| throws Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#result-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-">FutureAction</a></code></span></div> |
| <div class="block">Awaits and returns the result (of type T) of this action. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#result-scala.concurrent.duration.Duration-scala.concurrent.CanAwait-">result</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>result</code> in interface <code>scala.concurrent.Awaitable<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>atMost</code> - maximum wait time, which may be negative (no waiting is done), Duration.Inf |
| for unbounded waiting, or a finite positive duration</dd> |
| <dd><code>permit</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result value if the action is completed within the specific maximum wait time</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>Exception</code> - exception during action execution</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transform-scala.Function1-scala.concurrent.ExecutionContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transform</h4> |
| <pre>public <S> scala.concurrent.Future<S> transform(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>,scala.util.Try<S>> f, |
| scala.concurrent.ExecutionContext e)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>transform</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transformWith-scala.Function1-scala.concurrent.ExecutionContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transformWith</h4> |
| <pre>public <S> scala.concurrent.Future<S> transformWith(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>,scala.concurrent.Future<S>> f, |
| scala.concurrent.ExecutionContext e)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>transformWith</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="value--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public scala.Option<scala.util.Try<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>>> value()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#value--">FutureAction</a></code></span></div> |
| <div class="block">The value of this Future. |
| <p> |
| If the future is not completed the returned value will be None. If the future is completed |
| the value will be Some(Success(t)) if it contains a valid result, or Some(Failure(error)) if |
| it contains an exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/spark/FutureAction.html#value--">value</a></code> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>value</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</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="../../../org/apache/spark/CleanupTaskWeakReference.html" title="class in org.apache.spark"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/spark/ContextAwareIterator.html" title="class in org.apache.spark"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/spark/ComplexFutureAction.html" target="_top">Frames</a></li> |
| <li><a href="ComplexFutureAction.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |