http://git-wip-us.apache.org/repos/asf/spark-website/blob/24d32b75/site/docs/1.6.3/api/java/org/apache/spark/SimpleFutureAction.html ---------------------------------------------------------------------- diff --git a/site/docs/1.6.3/api/java/org/apache/spark/SimpleFutureAction.html b/site/docs/1.6.3/api/java/org/apache/spark/SimpleFutureAction.html new file mode 100644 index 0000000..32c985d --- /dev/null +++ b/site/docs/1.6.3/api/java/org/apache/spark/SimpleFutureAction.html @@ -0,0 +1,440 @@ +<!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_79) on Wed Nov 02 15:16:17 PDT 2016 --> +<title>SimpleFutureAction (Spark 1.6.3 JavaDoc)</title> +<meta name="date" content="2016-11-02"> +<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="SimpleFutureAction (Spark 1.6.3 JavaDoc)"; + } +//--> +</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/ShuffleDependency.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/spark/SparkConf.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/SimpleFutureAction.html" target="_top">Frames</a></li> +<li><a href="SimpleFutureAction.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 SimpleFutureAction" class="title">Class SimpleFutureAction<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.SimpleFutureAction<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="strong">SimpleFutureAction<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> holding the result of an action that triggers a single job. Examples include + count, collect, reduce.</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$</code></li> +</ul> +</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"> </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/SimpleFutureAction.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/SimpleFutureAction.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/SimpleFutureAction.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<Object></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.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><U> void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#onComplete(scala.Function1,%20scala.concurrent.ExecutionContext)">onComplete</a></strong>(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">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 class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SimpleFutureAction.html" title="class in org.apache.spark">SimpleFutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#ready(scala.concurrent.duration.Duration,%20scala.concurrent.CanAwait)">ready</a></strong>(scala.concurrent.duration.Duration atMost, + scala.concurrent.CanAwait 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/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.html#result(scala.concurrent.duration.Duration,%20scala.concurrent.CanAwait)">result</a></strong>(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 class="rowColor"> +<td class="colFirst"><code>scala.Option<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SimpleFutureAction.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_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>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"> +<!-- ============ 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"><strong>Description copied from interface: <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> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></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/SimpleFutureAction.html" title="class in org.apache.spark">SimpleFutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>> ready(scala.concurrent.duration.Duration atMost, + scala.concurrent.CanAwait permit)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#ready(scala.concurrent.duration.Duration,%20scala.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,%20scala.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/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>ready</code> in interface <code>scala.concurrent.Awaitable<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></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 <a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a> result(scala.concurrent.duration.Duration atMost, + scala.concurrent.CanAwait permit)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#result(scala.concurrent.duration.Duration,%20scala.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,%20scala.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/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>result</code> in interface <code>scala.concurrent.Awaitable<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></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 <U> void onComplete(scala.Function1<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>>,U> func, + scala.concurrent.ExecutionContext executor)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../org/apache/spark/FutureAction.html#onComplete(scala.Function1,%20scala.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,%20scala.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/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>onComplete</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></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 boolean isCompleted()</pre> +<div class="block"><strong>Description copied from interface: <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> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>isCompleted</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</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"><strong>Description copied from interface: <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> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></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 scala.Option<scala.util.Try<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>>> value()</pre> +<div class="block"><strong>Description copied from interface: <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> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>value</code> in interface <code>scala.concurrent.Future<<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></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 scala.collection.Seq<Object> jobIds()</pre> +<div class="block"><strong>Description copied from interface: <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> in interface <code><a href="../../../org/apache/spark/FutureAction.html" title="interface in org.apache.spark">FutureAction</a><<a href="../../../org/apache/spark/SimpleFutureAction.html" title="type parameter in SimpleFutureAction">T</a>></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/ShuffleDependency.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/spark/SparkConf.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/SimpleFutureAction.html" target="_top">Frames</a></li> +<li><a href="SimpleFutureAction.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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>
http://git-wip-us.apache.org/repos/asf/spark-website/blob/24d32b75/site/docs/1.6.3/api/java/org/apache/spark/SparkConf.html ---------------------------------------------------------------------- diff --git a/site/docs/1.6.3/api/java/org/apache/spark/SparkConf.html b/site/docs/1.6.3/api/java/org/apache/spark/SparkConf.html new file mode 100644 index 0000000..641de06 --- /dev/null +++ b/site/docs/1.6.3/api/java/org/apache/spark/SparkConf.html @@ -0,0 +1,1166 @@ +<!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_79) on Wed Nov 02 15:16:17 PDT 2016 --> +<title>SparkConf (Spark 1.6.3 JavaDoc)</title> +<meta name="date" content="2016-11-02"> +<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="SparkConf (Spark 1.6.3 JavaDoc)"; + } +//--> +</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/SimpleFutureAction.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/spark/SparkContext.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/SparkConf.html" target="_top">Frames</a></li> +<li><a href="SparkConf.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 SparkConf" class="title">Class SparkConf</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.SparkConf</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>Cloneable, <a href="../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SparkConf</span> +extends Object +implements scala.Cloneable, <a href="../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></pre> +<div class="block">Configuration for a Spark application. Used to set various Spark parameters as key-value pairs. + <p> + Most of the time, you would create a SparkConf object with <code>new SparkConf()</code>, which will load + values from any <code>spark.*</code> Java system properties set in your application as well. In this case, + parameters you set directly on the <code>SparkConf</code> object take priority over system properties. + <p> + For unit tests, you can also call <code>new SparkConf(false)</code> to skip loading external settings and + get the same configuration no matter what the system properties are. + <p> + All setter methods in this class support chaining. For example, you can write + <code>new SparkConf().setMaster("local").setAppName("My app")</code>. + <p> + Note that once a SparkConf object is passed to Spark, it is cloned and can no longer be modified + by the user. Spark does not support modifying the configuration at runtime. + <p> + param: loadDefaults whether to also load values from Java system properties</div> +</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"> </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/SparkConf.html#SparkConf()">SparkConf</a></strong>()</code> +<div class="block">Create a SparkConf that loads defaults from system properties and the classpath</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../org/apache/spark/SparkConf.html#SparkConf(boolean)">SparkConf</a></strong>(boolean loadDefaults)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#clone()">clone</a></strong>()</code> +<div class="block">Copy this object</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#contains(java.lang.String)">contains</a></strong>(String key)</code> +<div class="block">Does the configuration contain a given parameter?</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>String</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#get(java.lang.String)">get</a></strong>(String key)</code> +<div class="block">Get a parameter; throws a NoSuchElementException if it's not set</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>String</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#get(java.lang.String,%20java.lang.String)">get</a></strong>(String key, + String defaultValue)</code> +<div class="block">Get a parameter, falling back to a default if not set</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>scala.collection.Seq<scala.Tuple2<String,String>></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getAkkaConf()">getAkkaConf</a></strong>()</code> +<div class="block">Get all akka conf variables set on this SparkConf</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>scala.Tuple2<String,String>[]</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getAll()">getAll</a></strong>()</code> +<div class="block">Get all parameters as a list of pairs</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>String</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getAppId()">getAppId</a></strong>()</code> +<div class="block">Returns the Spark application id, valid in the Driver after TaskScheduler registration and + from the start in the Executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>scala.collection.immutable.Map<Object,String></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getAvroSchema()">getAvroSchema</a></strong>()</code> +<div class="block">Gets all the avro schemas in the configuration used in the generic Avro record serializer</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getBoolean(java.lang.String,%20boolean)">getBoolean</a></strong>(String key, + boolean defaultValue)</code> +<div class="block">Get a parameter as a boolean, falling back to a default if not set</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static scala.Option<String></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getDeprecatedConfig(java.lang.String,%20org.apache.spark.SparkConf)">getDeprecatedConfig</a></strong>(String key, + <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> conf)</code> +<div class="block">Looks for available deprecated keys for the given config option, and return the first + value available.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getDouble(java.lang.String,%20double)">getDouble</a></strong>(String key, + double defaultValue)</code> +<div class="block">Get a parameter as a double, falling back to a default if not set</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>scala.collection.Seq<scala.Tuple2<String,String>></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getExecutorEnv()">getExecutorEnv</a></strong>()</code> +<div class="block">Get all executor environment variables set on this SparkConf</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getInt(java.lang.String,%20int)">getInt</a></strong>(String key, + int defaultValue)</code> +<div class="block">Get a parameter as an integer, falling back to a default if not set</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getLong(java.lang.String,%20long)">getLong</a></strong>(String key, + long defaultValue)</code> +<div class="block">Get a parameter as a long, falling back to a default if not set</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>scala.Option<String></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getOption(java.lang.String)">getOption</a></strong>(String key)</code> +<div class="block">Get a parameter as an Option</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsBytes(java.lang.String)">getSizeAsBytes</a></strong>(String key)</code> +<div class="block">Get a size parameter as bytes; throws a NoSuchElementException if it's not set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsBytes(java.lang.String,%20long)">getSizeAsBytes</a></strong>(String key, + long defaultValue)</code> +<div class="block">Get a size parameter as bytes, falling back to a default if not set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsBytes(java.lang.String,%20java.lang.String)">getSizeAsBytes</a></strong>(String key, + String defaultValue)</code> +<div class="block">Get a size parameter as bytes, falling back to a default if not set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsGb(java.lang.String)">getSizeAsGb</a></strong>(String key)</code> +<div class="block">Get a size parameter as Gibibytes; throws a NoSuchElementException if it's not set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsGb(java.lang.String,%20java.lang.String)">getSizeAsGb</a></strong>(String key, + String defaultValue)</code> +<div class="block">Get a size parameter as Gibibytes, falling back to a default if not set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsKb(java.lang.String)">getSizeAsKb</a></strong>(String key)</code> +<div class="block">Get a size parameter as Kibibytes; throws a NoSuchElementException if it's not set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsKb(java.lang.String,%20java.lang.String)">getSizeAsKb</a></strong>(String key, + String defaultValue)</code> +<div class="block">Get a size parameter as Kibibytes, falling back to a default if not set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsMb(java.lang.String)">getSizeAsMb</a></strong>(String key)</code> +<div class="block">Get a size parameter as Mebibytes; throws a NoSuchElementException if it's not set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getSizeAsMb(java.lang.String,%20java.lang.String)">getSizeAsMb</a></strong>(String key, + String defaultValue)</code> +<div class="block">Get a size parameter as Mebibytes, falling back to a default if not set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getTimeAsMs(java.lang.String)">getTimeAsMs</a></strong>(String key)</code> +<div class="block">Get a time parameter as milliseconds; throws a NoSuchElementException if it's not set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getTimeAsMs(java.lang.String,%20java.lang.String)">getTimeAsMs</a></strong>(String key, + String defaultValue)</code> +<div class="block">Get a time parameter as milliseconds, falling back to a default if not set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getTimeAsSeconds(java.lang.String)">getTimeAsSeconds</a></strong>(String key)</code> +<div class="block">Get a time parameter as seconds; throws a NoSuchElementException if it's not set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#getTimeAsSeconds(java.lang.String,%20java.lang.String)">getTimeAsSeconds</a></strong>(String key, + String defaultValue)</code> +<div class="block">Get a time parameter as seconds, falling back to a default if not set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#isAkkaConf(java.lang.String)">isAkkaConf</a></strong>(String name)</code> +<div class="block">Return whether the given config is an akka config (e.g.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#isExecutorStartupConf(java.lang.String)">isExecutorStartupConf</a></strong>(String name)</code> +<div class="block">Return whether the given config should be passed to an executor on start-up.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#isSparkPortConf(java.lang.String)">isSparkPortConf</a></strong>(String name)</code> +<div class="block">Return true if the given config matches either <code>spark.*.port</code> or <code>spark.port.*</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#logDeprecationWarning(java.lang.String)">logDeprecationWarning</a></strong>(String key)</code> +<div class="block">Logs a warning message if the given config key is deprecated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#registerAvroSchemas(scala.collection.Seq)">registerAvroSchemas</a></strong>(scala.collection.Seq<org.apache.avro.Schema> schemas)</code> +<div class="block">Use Kryo serialization and register the given set of Avro schemas so that the generic + record serializer can decrease network IO</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#registerKryoClasses(java.lang.Class[])">registerKryoClasses</a></strong>(Class<?>[] classes)</code> +<div class="block">Use Kryo serialization and register the given set of classes with Kryo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#remove(java.lang.String)">remove</a></strong>(String key)</code> +<div class="block">Remove a parameter from the configuration</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#set(java.lang.String,%20java.lang.String)">set</a></strong>(String key, + String value)</code> +<div class="block">Set a configuration variable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setAll(scala.collection.Traversable)">setAll</a></strong>(scala.collection.Traversable<scala.Tuple2<String,String>> settings)</code> +<div class="block">Set multiple parameters together</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setAppName(java.lang.String)">setAppName</a></strong>(String name)</code> +<div class="block">Set a name for your application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setExecutorEnv(scala.collection.Seq)">setExecutorEnv</a></strong>(scala.collection.Seq<scala.Tuple2<String,String>> variables)</code> +<div class="block">Set multiple environment variables to be used when launching executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setExecutorEnv(java.lang.String,%20java.lang.String)">setExecutorEnv</a></strong>(String variable, + String value)</code> +<div class="block">Set an environment variable to be used when launching executors for this application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setExecutorEnv(scala.Tuple2[])">setExecutorEnv</a></strong>(scala.Tuple2<String,String>[] variables)</code> +<div class="block">Set multiple environment variables to be used when launching executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setIfMissing(java.lang.String,%20java.lang.String)">setIfMissing</a></strong>(String key, + String value)</code> +<div class="block">Set a parameter if it isn't already configured</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setJars(scala.collection.Seq)">setJars</a></strong>(scala.collection.Seq<String> jars)</code> +<div class="block">Set JAR files to distribute to the cluster.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setJars(java.lang.String[])">setJars</a></strong>(String[] jars)</code> +<div class="block">Set JAR files to distribute to the cluster.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setMaster(java.lang.String)">setMaster</a></strong>(String master)</code> +<div class="block">The master URL to connect to, such as "local" to run locally with one thread, "local[4]" to + run locally with 4 cores, or "spark://master:7077" to run on a Spark standalone cluster.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#setSparkHome(java.lang.String)">setSparkHome</a></strong>(String home)</code> +<div class="block">Set the location where Spark is installed on worker nodes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>String</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkConf.html#toDebugString()">toDebugString</a></strong>()</code> +<div class="block">Return a string listing all keys and values, one per line.</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.Logging"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.spark.<a href="../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></h3> +<code><a href="../../../org/apache/spark/Logging.html#initializeIfNecessary()">initializeIfNecessary</a>, <a href="../../../org/apache/spark/Logging.html#initializeLogging()">initializeLogging</a>, <a href="../../../org/apache/spark/Logging.html#isTraceEnabled()">isTraceEnabled</a>, <a href="../../../org/apache/spark/Logging.html#log_()">log_</a>, <a href="../../../org/apache/spark/Logging.html#log()">log</a>, <a href="../../../org/apache/spark/Logging.html#logDebug(scala.Function0)">logDebug</a>, <a href="../../../org/apache/spark/Logging.html#logDebug(scala.Function0,%20java.lang.Throwable)">logDebug</a>, <a href="../../../org/apache/spark/Logging.html#logError(scala.Function0)">logError</a>, <a href="../../../org/apache/spark/Logging.html#logError(scala.Function0,%20java.lang.Throwable)">logError</a>, <a href="../../../org/apache/spark/Logging.html#logInfo(scala.Function0)">logInfo</a>, <a href="../../../org/apache/spark/Logging.html#logInfo(scala.Function0,%20java.lang.Throwable )">logInfo</a>, <a href="../../../org/apache/spark/Logging.html#logName()">logName</a>, <a href="../../../org/apache/spark/Logging.html#logTrace(scala.Function0)">logTrace</a>, <a href="../../../org/apache/spark/Logging.html#logTrace(scala.Function0,%20java.lang.Throwable)">logTrace</a>, <a href="../../../org/apache/spark/Logging.html#logWarning(scala.Function0)">logWarning</a>, <a href="../../../org/apache/spark/Logging.html#logWarning(scala.Function0,%20java.lang.Throwable)">logWarning</a></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="SparkConf(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SparkConf</h4> +<pre>public SparkConf(boolean loadDefaults)</pre> +</li> +</ul> +<a name="SparkConf()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SparkConf</h4> +<pre>public SparkConf()</pre> +<div class="block">Create a SparkConf that loads defaults from system properties and the classpath</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isAkkaConf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAkkaConf</h4> +<pre>public static boolean isAkkaConf(String name)</pre> +<div class="block">Return whether the given config is an akka config (e.g. akka.actor.provider). + Note that this does not include spark-specific akka configs (e.g. spark.akka.timeout).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="isExecutorStartupConf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExecutorStartupConf</h4> +<pre>public static boolean isExecutorStartupConf(String name)</pre> +<div class="block">Return whether the given config should be passed to an executor on start-up. + <p> + Certain akka and authentication configs are required from the executor when it connects to + the scheduler, while the rest of the spark configs can be inherited from the driver later.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="isSparkPortConf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSparkPortConf</h4> +<pre>public static boolean isSparkPortConf(String name)</pre> +<div class="block">Return true if the given config matches either <code>spark.*.port</code> or <code>spark.port.*</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getDeprecatedConfig(java.lang.String, org.apache.spark.SparkConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeprecatedConfig</h4> +<pre>public static scala.Option<String> getDeprecatedConfig(String key, + <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> conf)</pre> +<div class="block">Looks for available deprecated keys for the given config option, and return the first + value available.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>conf</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="logDeprecationWarning(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logDeprecationWarning</h4> +<pre>public static void logDeprecationWarning(String key)</pre> +<div class="block">Logs a warning message if the given config key is deprecated.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd></dl> +</li> +</ul> +<a name="set(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> set(String key, + String value)</pre> +<div class="block">Set a configuration variable.</div> +</li> +</ul> +<a name="setMaster(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setMaster(String master)</pre> +<div class="block">The master URL to connect to, such as "local" to run locally with one thread, "local[4]" to + run locally with 4 cores, or "spark://master:7077" to run on a Spark standalone cluster.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>master</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="setAppName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAppName</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setAppName(String name)</pre> +<div class="block">Set a name for your application. Shown in the Spark web UI.</div> +</li> +</ul> +<a name="setJars(scala.collection.Seq)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setJars</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setJars(scala.collection.Seq<String> jars)</pre> +<div class="block">Set JAR files to distribute to the cluster.</div> +</li> +</ul> +<a name="setJars(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setJars</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setJars(String[] jars)</pre> +<div class="block">Set JAR files to distribute to the cluster. (Java-friendly version.)</div> +</li> +</ul> +<a name="setExecutorEnv(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutorEnv</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setExecutorEnv(String variable, + String value)</pre> +<div class="block">Set an environment variable to be used when launching executors for this application. + These variables are stored as properties of the form spark.executorEnv.VAR_NAME + (for example spark.executorEnv.PATH) but this method makes them easier to set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>variable</code> - (undocumented)</dd><dd><code>value</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="setExecutorEnv(scala.collection.Seq)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutorEnv</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setExecutorEnv(scala.collection.Seq<scala.Tuple2<String,String>> variables)</pre> +<div class="block">Set multiple environment variables to be used when launching executors. + These variables are stored as properties of the form spark.executorEnv.VAR_NAME + (for example spark.executorEnv.PATH) but this method makes them easier to set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>variables</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="setExecutorEnv(scala.Tuple2[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutorEnv</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setExecutorEnv(scala.Tuple2<String,String>[] variables)</pre> +<div class="block">Set multiple environment variables to be used when launching executors. + (Java-friendly version.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>variables</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="setSparkHome(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSparkHome</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setSparkHome(String home)</pre> +<div class="block">Set the location where Spark is installed on worker nodes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>home</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="setAll(scala.collection.Traversable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAll</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setAll(scala.collection.Traversable<scala.Tuple2<String,String>> settings)</pre> +<div class="block">Set multiple parameters together</div> +</li> +</ul> +<a name="setIfMissing(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIfMissing</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> setIfMissing(String key, + String value)</pre> +<div class="block">Set a parameter if it isn't already configured</div> +</li> +</ul> +<a name="registerKryoClasses(java.lang.Class[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerKryoClasses</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> registerKryoClasses(Class<?>[] classes)</pre> +<div class="block">Use Kryo serialization and register the given set of classes with Kryo. + If called multiple times, this will append the classes from all calls together.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classes</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="registerAvroSchemas(scala.collection.Seq)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerAvroSchemas</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> registerAvroSchemas(scala.collection.Seq<org.apache.avro.Schema> schemas)</pre> +<div class="block">Use Kryo serialization and register the given set of Avro schemas so that the generic + record serializer can decrease network IO</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>schemas</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getAvroSchema()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAvroSchema</h4> +<pre>public scala.collection.immutable.Map<Object,String> getAvroSchema()</pre> +<div class="block">Gets all the avro schemas in the configuration used in the generic Avro record serializer</div> +</li> +</ul> +<a name="remove(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> remove(String key)</pre> +<div class="block">Remove a parameter from the configuration</div> +</li> +</ul> +<a name="get(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public String get(String key)</pre> +<div class="block">Get a parameter; throws a NoSuchElementException if it's not set</div> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public String get(String key, + String defaultValue)</pre> +<div class="block">Get a parameter, falling back to a default if not set</div> +</li> +</ul> +<a name="getTimeAsSeconds(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeAsSeconds</h4> +<pre>public long getTimeAsSeconds(String key)</pre> +<div class="block">Get a time parameter as seconds; throws a NoSuchElementException if it's not set. If no + suffix is provided then seconds are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>NoSuchElementException</code></dd></dl> +</li> +</ul> +<a name="getTimeAsSeconds(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeAsSeconds</h4> +<pre>public long getTimeAsSeconds(String key, + String defaultValue)</pre> +<div class="block">Get a time parameter as seconds, falling back to a default if not set. If no + suffix is provided then seconds are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>defaultValue</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getTimeAsMs(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeAsMs</h4> +<pre>public long getTimeAsMs(String key)</pre> +<div class="block">Get a time parameter as milliseconds; throws a NoSuchElementException if it's not set. If no + suffix is provided then milliseconds are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>NoSuchElementException</code></dd></dl> +</li> +</ul> +<a name="getTimeAsMs(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeAsMs</h4> +<pre>public long getTimeAsMs(String key, + String defaultValue)</pre> +<div class="block">Get a time parameter as milliseconds, falling back to a default if not set. If no + suffix is provided then milliseconds are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>defaultValue</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getSizeAsBytes(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsBytes</h4> +<pre>public long getSizeAsBytes(String key)</pre> +<div class="block">Get a size parameter as bytes; throws a NoSuchElementException if it's not set. If no + suffix is provided then bytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>NoSuchElementException</code></dd></dl> +</li> +</ul> +<a name="getSizeAsBytes(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsBytes</h4> +<pre>public long getSizeAsBytes(String key, + String defaultValue)</pre> +<div class="block">Get a size parameter as bytes, falling back to a default if not set. If no + suffix is provided then bytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>defaultValue</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getSizeAsBytes(java.lang.String, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsBytes</h4> +<pre>public long getSizeAsBytes(String key, + long defaultValue)</pre> +<div class="block">Get a size parameter as bytes, falling back to a default if not set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>defaultValue</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getSizeAsKb(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsKb</h4> +<pre>public long getSizeAsKb(String key)</pre> +<div class="block">Get a size parameter as Kibibytes; throws a NoSuchElementException if it's not set. If no + suffix is provided then Kibibytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>NoSuchElementException</code></dd></dl> +</li> +</ul> +<a name="getSizeAsKb(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsKb</h4> +<pre>public long getSizeAsKb(String key, + String defaultValue)</pre> +<div class="block">Get a size parameter as Kibibytes, falling back to a default if not set. If no + suffix is provided then Kibibytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>defaultValue</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getSizeAsMb(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsMb</h4> +<pre>public long getSizeAsMb(String key)</pre> +<div class="block">Get a size parameter as Mebibytes; throws a NoSuchElementException if it's not set. If no + suffix is provided then Mebibytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>NoSuchElementException</code></dd></dl> +</li> +</ul> +<a name="getSizeAsMb(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsMb</h4> +<pre>public long getSizeAsMb(String key, + String defaultValue)</pre> +<div class="block">Get a size parameter as Mebibytes, falling back to a default if not set. If no + suffix is provided then Mebibytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>defaultValue</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getSizeAsGb(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsGb</h4> +<pre>public long getSizeAsGb(String key)</pre> +<div class="block">Get a size parameter as Gibibytes; throws a NoSuchElementException if it's not set. If no + suffix is provided then Gibibytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>NoSuchElementException</code></dd></dl> +</li> +</ul> +<a name="getSizeAsGb(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSizeAsGb</h4> +<pre>public long getSizeAsGb(String key, + String defaultValue)</pre> +<div class="block">Get a size parameter as Gibibytes, falling back to a default if not set. If no + suffix is provided then Gibibytes are assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - (undocumented)</dd><dd><code>defaultValue</code> - (undocumented)</dd> +<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="getOption(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOption</h4> +<pre>public scala.Option<String> getOption(String key)</pre> +<div class="block">Get a parameter as an Option</div> +</li> +</ul> +<a name="getAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAll</h4> +<pre>public scala.Tuple2<String,String>[] getAll()</pre> +<div class="block">Get all parameters as a list of pairs</div> +</li> +</ul> +<a name="getInt(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt(String key, + int defaultValue)</pre> +<div class="block">Get a parameter as an integer, falling back to a default if not set</div> +</li> +</ul> +<a name="getLong(java.lang.String, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLong</h4> +<pre>public long getLong(String key, + long defaultValue)</pre> +<div class="block">Get a parameter as a long, falling back to a default if not set</div> +</li> +</ul> +<a name="getDouble(java.lang.String, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble(String key, + double defaultValue)</pre> +<div class="block">Get a parameter as a double, falling back to a default if not set</div> +</li> +</ul> +<a name="getBoolean(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean(String key, + boolean defaultValue)</pre> +<div class="block">Get a parameter as a boolean, falling back to a default if not set</div> +</li> +</ul> +<a name="getExecutorEnv()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExecutorEnv</h4> +<pre>public scala.collection.Seq<scala.Tuple2<String,String>> getExecutorEnv()</pre> +<div class="block">Get all executor environment variables set on this SparkConf</div> +</li> +</ul> +<a name="getAkkaConf()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAkkaConf</h4> +<pre>public scala.collection.Seq<scala.Tuple2<String,String>> getAkkaConf()</pre> +<div class="block">Get all akka conf variables set on this SparkConf</div> +</li> +</ul> +<a name="getAppId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAppId</h4> +<pre>public String getAppId()</pre> +<div class="block">Returns the Spark application id, valid in the Driver after TaskScheduler registration and + from the start in the Executor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl> +</li> +</ul> +<a name="contains(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(String key)</pre> +<div class="block">Does the configuration contain a given parameter?</div> +</li> +</ul> +<a name="clone()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clone</h4> +<pre>public <a href="../../../org/apache/spark/SparkConf.html" title="class in org.apache.spark">SparkConf</a> clone()</pre> +<div class="block">Copy this object</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>clone</code> in class <code>Object</code></dd> +</dl> +</li> +</ul> +<a name="toDebugString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toDebugString</h4> +<pre>public String toDebugString()</pre> +<div class="block">Return a string listing all keys and values, one per line. This is useful to print the + configuration out for debugging.</div> +<dl><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/SimpleFutureAction.html" title="class in org.apache.spark"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../org/apache/spark/SparkContext.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/SparkConf.html" target="_top">Frames</a></li> +<li><a href="SparkConf.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> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org
