summaryrefslogtreecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/ComplexFutureAction.html
blob: 8198fb7d9c9bb343d25667faca57243814e52e51 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
<!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>ComplexFutureAction</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="ComplexFutureAction";
    }
//-->
</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/CleanupTaskWeakReference.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/Dependency.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/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:&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 ComplexFutureAction" class="title">Class ComplexFutureAction&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ComplexFutureAction&lt;T&gt;</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>&lt;T&gt;, scala.concurrent.Awaitable&lt;T&gt;, scala.concurrent.Future&lt;T&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ComplexFutureAction&lt;T&gt;</span>
extends java.lang.Object
implements <a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;T&gt;</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 interrupting the
 action thread if it is being blocked by a job.</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&nbsp;scala.concurrent.Future</h3>
<code>scala.concurrent.Future.InternalCallbackExecutor$</code></li>
</ul>
</li>
</ul>
<!-- ======== 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/ComplexFutureAction.html#ComplexFutureAction()">ComplexFutureAction</a></strong>()</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#cancel()">cancel</a></strong>()</code>
<div class="block">Cancels the execution of this action.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#isCancelled()">isCancelled</a></strong>()</code>
<div class="block">Returns whether the action has been cancelled.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#isCompleted()">isCompleted</a></strong>()</code>
<div class="block">Returns whether the action has already been completed with a value or an exception.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.collection.Seq&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#jobIds()">jobIds</a></strong>()</code>
<div class="block">Returns the job IDs run by the underlying async operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;U&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#onComplete(scala.Function1, scala.concurrent.ExecutionContext)">onComplete</a></strong>(scala.Function1&lt;scala.util.Try&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;,U&gt;&nbsp;func,
          scala.concurrent.ExecutionContext&nbsp;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 class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/spark/ComplexFutureAction.html" title="class in org.apache.spark">ComplexFutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#ready(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">ready</a></strong>(scala.concurrent.duration.Duration&nbsp;atMost,
     scala.concurrent.CanAwait&nbsp;permit)</code>
<div class="block">Blocks until this action completes.</div>
</td>
</tr>
<tr 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><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#result(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">result</a></strong>(scala.concurrent.duration.Duration&nbsp;atMost,
      scala.concurrent.CanAwait&nbsp;permit)</code>
<div class="block">Awaits and returns the result (of type T) of this action.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/spark/ComplexFutureAction.html" title="class in org.apache.spark">ComplexFutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#run(scala.Function0, scala.concurrent.ExecutionContext)">run</a></strong>(scala.Function0&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;&nbsp;func,
   scala.concurrent.ExecutionContext&nbsp;executor)</code>
<div class="block">Executes some action enclosed in the closure.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T,U,R&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#runJob(org.apache.spark.rdd.RDD, scala.Function1, scala.collection.Seq, scala.Function2, scala.Function0)">runJob</a></strong>(<a href="../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;T&gt;&nbsp;rdd,
      scala.Function1&lt;scala.collection.Iterator&lt;T&gt;,U&gt;&nbsp;processPartition,
      scala.collection.Seq&lt;java.lang.Object&gt;&nbsp;partitions,
      scala.Function2&lt;java.lang.Object,U,scala.runtime.BoxedUnit&gt;&nbsp;resultHandler,
      scala.Function0&lt;R&gt;&nbsp;resultFunc)</code>
<div class="block">Runs a Spark job.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.Option&lt;scala.util.Try&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/ComplexFutureAction.html#value()">value</a></strong>()</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_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_org.apache.spark.FutureAction">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;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&nbsp;scala.concurrent.Future</h3>
<code>andThen, collect, failed, fallbackTo, filter, flatMap, foreach, map, mapTo, onFailure, onSuccess, recover, recoverWith, transform, withFilter, zip</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()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ComplexFutureAction</h4>
<pre>public&nbsp;ComplexFutureAction()</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&nbsp;void&nbsp;cancel()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#cancel()">FutureAction</a></code></strong></div>
<div class="block">Cancels the execution of this action.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#cancel()">cancel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="run(scala.Function0, scala.concurrent.ExecutionContext)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="class in org.apache.spark">ComplexFutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;&nbsp;run(scala.Function0&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;&nbsp;func,
                         scala.concurrent.ExecutionContext&nbsp;executor)</pre>
<div class="block">Executes some action enclosed in the closure. To properly enable cancellation, the closure
 should use runJob implementation in this promise. See takeAsync for example.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>func</code> - (undocumented)</dd><dd><code>executor</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="runJob(org.apache.spark.rdd.RDD, scala.Function1, scala.collection.Seq, scala.Function2, scala.Function0)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runJob</h4>
<pre>public&nbsp;&lt;T,U,R&gt;&nbsp;void&nbsp;runJob(<a href="../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;T&gt;&nbsp;rdd,
                  scala.Function1&lt;scala.collection.Iterator&lt;T&gt;,U&gt;&nbsp;processPartition,
                  scala.collection.Seq&lt;java.lang.Object&gt;&nbsp;partitions,
                  scala.Function2&lt;java.lang.Object,U,scala.runtime.BoxedUnit&gt;&nbsp;resultHandler,
                  scala.Function0&lt;R&gt;&nbsp;resultFunc)</pre>
<div class="block">Runs a Spark job. This is a wrapper around the same functionality provided by SparkContext
 to enable cancellation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rdd</code> - (undocumented)</dd><dd><code>processPartition</code> - (undocumented)</dd><dd><code>partitions</code> - (undocumented)</dd><dd><code>resultHandler</code> - (undocumented)</dd><dd><code>resultFunc</code> - (undocumented)</dd></dl>
</li>
</ul>
<a name="isCancelled()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCancelled</h4>
<pre>public&nbsp;boolean&nbsp;isCancelled()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#isCancelled()">FutureAction</a></code></strong></div>
<div class="block">Returns whether the action has been cancelled.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#isCancelled()">isCancelled</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(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&nbsp;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="class in org.apache.spark">ComplexFutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;&nbsp;ready(scala.concurrent.duration.Duration&nbsp;atMost,
                           scala.concurrent.CanAwait&nbsp;permit)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#ready(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">FutureAction</a></code></strong></div>
<div class="block">Blocks until this action completes.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#ready(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">ready</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>ready</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Awaitable&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><span class="strong">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="strong">Returns:</span></dt><dd>this FutureAction</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&nbsp;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&nbsp;result(scala.concurrent.duration.Duration&nbsp;atMost,
       scala.concurrent.CanAwait&nbsp;permit)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#result(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">FutureAction</a></code></strong></div>
<div class="block">Awaits and returns the result (of type T) of this action.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#result(scala.concurrent.duration.Duration, scala.concurrent.CanAwait)">result</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>result</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Awaitable&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><span class="strong">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="strong">Returns:</span></dt><dd>the result value if the action is completed within the specific maximum wait time</dd></dl>
</li>
</ul>
<a name="onComplete(scala.Function1, scala.concurrent.ExecutionContext)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onComplete</h4>
<pre>public&nbsp;&lt;U&gt;&nbsp;void&nbsp;onComplete(scala.Function1&lt;scala.util.Try&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;,U&gt;&nbsp;func,
                  scala.concurrent.ExecutionContext&nbsp;executor)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#onComplete(scala.Function1, scala.concurrent.ExecutionContext)">FutureAction</a></code></strong></div>
<div class="block">When this action is completed, either through an exception, or a value, applies the provided
 function.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#onComplete(scala.Function1, scala.concurrent.ExecutionContext)">onComplete</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>onComplete</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Future&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>func</code> - (undocumented)</dd><dd><code>executor</code> - (undocumented)</dd></dl>
</li>
</ul>
<a name="isCompleted()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCompleted</h4>
<pre>public&nbsp;boolean&nbsp;isCompleted()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#isCompleted()">FutureAction</a></code></strong></div>
<div class="block">Returns whether the action has already been completed with a value or an exception.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#isCompleted()">isCompleted</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>isCompleted</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Future&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="value()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>value</h4>
<pre>public&nbsp;scala.Option&lt;scala.util.Try&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;&gt;&nbsp;value()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#value()">FutureAction</a></code></strong></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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#value()">value</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>value</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Future&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="jobIds()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>jobIds</h4>
<pre>public&nbsp;scala.collection.Seq&lt;java.lang.Object&gt;&nbsp;jobIds()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html#jobIds()">FutureAction</a></code></strong></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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../org/apache/spark/FutureAction.html#jobIds()">jobIds</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="../../../org/apache/spark/ComplexFutureAction.html" title="type parameter in ComplexFutureAction">T</a>&gt;</code></dd>
<dt><span class="strong">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><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/CleanupTaskWeakReference.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/Dependency.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/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:&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>