Google Git
Sign in
apache / spark-website / f7fc275b5cd176e4d65d70f1b933e7fcce370584 / . / site / docs / 4.0.0-preview1 / api / java / org / apache / spark / FutureAction.html
blob: 318fc265099aab269d75eb3de1e620514f9fe381 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue May 28 17:21:12 UTC 2024 -->
<title>FutureAction (Spark 4.0.0-preview1 JavaDoc)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-05-28">
<meta name="description" content="declaration: package: org.apache.spark, interface: FutureAction">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.spark</a></div>
<h1 title="Interface FutureAction" class="title">Interface FutureAction&lt;T&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code>scala.concurrent.Awaitable&lt;T&gt;</code>, <code>scala.concurrent.Future&lt;T&gt;</code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="ComplexFutureAction.html" title="class in org.apache.spark">ComplexFutureAction</a></code>, <code><a href="SimpleFutureAction.html" title="class in org.apache.spark">SimpleFutureAction</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">FutureAction&lt;T&gt;</span><span class="extends-implements">
extends scala.concurrent.Future&lt;T&gt;</span></div>
<div class="block">A future for the result of an action to support cancellation. This is an extension of the
Scala Future interface to support cancellation.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-scala.concurrent.Future">Nested classes/interfaces inherited from interface&nbsp;scala.concurrent.Future</h2>
<code>scala.concurrent.Future.never$</code></div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#cancel()" class="member-name-link">cancel</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Cancels the execution of this action.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FutureAction.html" title="type parameter in FutureAction">T</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#get()" class="member-name-link">get</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Blocks and returns the result of this job.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isCancelled()" class="member-name-link">isCancelled</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns whether the action has been cancelled.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isCompleted()" class="member-name-link">isCompleted</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns whether the action has already been completed with a value or an exception.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>scala.collection.immutable.Seq&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#jobIds()" class="member-name-link">jobIds</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the job IDs run by the underlying async operation.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>&lt;U&gt;&nbsp;void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#onComplete(scala.Function1,scala.concurrent.ExecutionContext)" class="member-name-link">onComplete</a><wbr>(scala.Function1&lt;scala.util.Try&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;,<wbr>U&gt;&nbsp;func,
scala.concurrent.ExecutionContext&nbsp;executor)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">When this action is completed, either through an exception, or a value, applies the provided
function.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#ready(scala.concurrent.duration.Duration,scala.concurrent.CanAwait)" class="member-name-link">ready</a><wbr>(scala.concurrent.duration.Duration&nbsp;atMost,
scala.concurrent.CanAwait&nbsp;permit)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Blocks until this action completes.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FutureAction.html" title="type parameter in FutureAction">T</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#result(scala.concurrent.duration.Duration,scala.concurrent.CanAwait)" class="member-name-link">result</a><wbr>(scala.concurrent.duration.Duration&nbsp;atMost,
scala.concurrent.CanAwait&nbsp;permit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Awaits and returns the result (of type T) of this action.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>scala.Option&lt;scala.util.Try&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#value()" class="member-name-link">value</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">The value of this Future.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-scala.concurrent.Future">Methods inherited from interface&nbsp;scala.concurrent.Future</h3>
<code>andThen, collect, failed, fallbackTo, filter, flatMap, flatten, foreach, map, mapTo, recover, recoverWith, transform, transform, transformWith, withFilter, zip, zipWith</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="cancel()">
<h3>cancel</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">cancel</span>()</div>
<div class="block">Cancels the execution of this action.</div>
</section>
</li>
<li>
<section class="detail" id="get()">
<h3>get</h3>
<div class="member-signature"><span class="return-type"><a href="FutureAction.html" title="type parameter in FutureAction">T</a></span>&nbsp;<span class="element-name">get</span>()
throws <span class="exceptions"><a href="SparkException.html" title="class in org.apache.spark">SparkException</a></span></div>
<div class="block">Blocks and returns the result of this job.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>(undocumented)</dd>
<dt>Throws:</dt>
<dd><code><a href="SparkException.html" title="class in org.apache.spark">SparkException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isCancelled()">
<h3>isCancelled</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isCancelled</span>()</div>
<div class="block">Returns whether the action has been cancelled.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>(undocumented)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isCompleted()">
<h3>isCompleted</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isCompleted</span>()</div>
<div class="block">Returns whether the action has already been completed with a value or an exception.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>isCompleted</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Future&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>(undocumented)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="jobIds()">
<h3>jobIds</h3>
<div class="member-signature"><span class="return-type">scala.collection.immutable.Seq&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span>&nbsp;<span class="element-name">jobIds</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 class="notes">
<dt>Returns:</dt>
<dd>(undocumented)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="onComplete(scala.Function1,scala.concurrent.ExecutionContext)">
<h3>onComplete</h3>
<div class="member-signature"><span class="type-parameters">&lt;U&gt;</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">onComplete</span><wbr><span class="parameters">(scala.Function1&lt;scala.util.Try&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;,<wbr>U&gt;&nbsp;func,
scala.concurrent.ExecutionContext&nbsp;executor)</span></div>
<div class="block">When this action is completed, either through an exception, or a value, applies the provided
function.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>onComplete</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Future&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;</code></dd>
<dt>Parameters:</dt>
<dd><code>func</code> - (undocumented)</dd>
<dd><code>executor</code> - (undocumented)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="ready(scala.concurrent.duration.Duration,scala.concurrent.CanAwait)">
<h3>ready</h3>
<div class="member-signature"><span class="return-type"><a href="FutureAction.html" title="interface in org.apache.spark">FutureAction</a>&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;</span>&nbsp;<span class="element-name">ready</span><wbr><span class="parameters">(scala.concurrent.duration.Duration&nbsp;atMost,
scala.concurrent.CanAwait&nbsp;permit)</span></div>
<div class="block">Blocks until this action completes.
<p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>ready</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Awaitable&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;</code></dd>
<dt>Parameters:</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>Returns:</dt>
<dd>this FutureAction</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="result(scala.concurrent.duration.Duration,scala.concurrent.CanAwait)">
<h3>result</h3>
<div class="member-signature"><span class="return-type"><a href="FutureAction.html" title="type parameter in FutureAction">T</a></span>&nbsp;<span class="element-name">result</span><wbr><span class="parameters">(scala.concurrent.duration.Duration&nbsp;atMost,
scala.concurrent.CanAwait&nbsp;permit)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
<div class="block">Awaits and returns the result (of type T) of this action.
<p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>result</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Awaitable&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;</code></dd>
<dt>Parameters:</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>Returns:</dt>
<dd>the result value if the action is completed within the specific maximum wait time</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - exception during action execution</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="value()">
<h3>value</h3>
<div class="member-signature"><span class="return-type">scala.Option&lt;scala.util.Try&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;&gt;</span>&nbsp;<span class="element-name">value</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 class="notes">
<dt>Specified by:</dt>
<dd><code>value</code>&nbsp;in interface&nbsp;<code>scala.concurrent.Future&lt;<a href="FutureAction.html" title="type parameter in FutureAction">T</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>(undocumented)</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
<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>