diff options
| author | Reynold Xin <rxin@apache.org> | 2015-09-08 23:20:31 +0000 |
|---|---|---|
| committer | Reynold Xin <rxin@apache.org> | 2015-09-08 23:20:31 +0000 |
| commit | 443d7fc272a34a818df4dd589bb251ec1087ae11 (patch) | |
| tree | 58b176846888d8824cd113146bd59568ea5354f6 /site/docs/1.5.0/api/java/org/apache/spark/launcher/SparkLauncher.html | |
| parent | 1037fcd3d980ca1bf8e79ccfecd1f5234545b6ff (diff) | |
| download | spark-website-443d7fc272a34a818df4dd589bb251ec1087ae11.tar.gz spark-website-443d7fc272a34a818df4dd589bb251ec1087ae11.tar.bz2 spark-website-443d7fc272a34a818df4dd589bb251ec1087ae11.zip | |
Added 1.5.0 docs.
Diffstat (limited to 'site/docs/1.5.0/api/java/org/apache/spark/launcher/SparkLauncher.html')
| -rw-r--r-- | site/docs/1.5.0/api/java/org/apache/spark/launcher/SparkLauncher.html | 781 |
1 files changed, 781 insertions, 0 deletions
diff --git a/site/docs/1.5.0/api/java/org/apache/spark/launcher/SparkLauncher.html b/site/docs/1.5.0/api/java/org/apache/spark/launcher/SparkLauncher.html new file mode 100644 index 000000000..6479bc117 --- /dev/null +++ b/site/docs/1.5.0/api/java/org/apache/spark/launcher/SparkLauncher.html @@ -0,0 +1,781 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_51) on Tue Sep 08 16:00:11 PDT 2015 --> +<title>SparkLauncher</title> +<meta name="date" content="2015-09-08"> +<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="SparkLauncher"; + } +//--> +</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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/spark/launcher/SparkLauncher.html" target="_top">Frames</a></li> +<li><a href="SparkLauncher.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.launcher</div> +<h2 title="Class SparkLauncher" class="title">Class SparkLauncher</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.launcher.SparkLauncher</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SparkLauncher</span> +extends java.lang.Object</pre> +<div class="block">Launcher for Spark applications. + <p> + Use this class to start Spark applications programmatically. The class uses a builder pattern + to allow clients to configure the Spark application and launch it as a child process. + </p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#DRIVER_EXTRA_CLASSPATH">DRIVER_EXTRA_CLASSPATH</a></strong></code> +<div class="block">Configuration key for the driver class path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#DRIVER_EXTRA_JAVA_OPTIONS">DRIVER_EXTRA_JAVA_OPTIONS</a></strong></code> +<div class="block">Configuration key for the driver VM options.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#DRIVER_EXTRA_LIBRARY_PATH">DRIVER_EXTRA_LIBRARY_PATH</a></strong></code> +<div class="block">Configuration key for the driver native library path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#DRIVER_MEMORY">DRIVER_MEMORY</a></strong></code> +<div class="block">Configuration key for the driver memory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#EXECUTOR_CORES">EXECUTOR_CORES</a></strong></code> +<div class="block">Configuration key for the number of executor CPU cores.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#EXECUTOR_EXTRA_CLASSPATH">EXECUTOR_EXTRA_CLASSPATH</a></strong></code> +<div class="block">Configuration key for the executor class path.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#EXECUTOR_EXTRA_JAVA_OPTIONS">EXECUTOR_EXTRA_JAVA_OPTIONS</a></strong></code> +<div class="block">Configuration key for the executor VM options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#EXECUTOR_EXTRA_LIBRARY_PATH">EXECUTOR_EXTRA_LIBRARY_PATH</a></strong></code> +<div class="block">Configuration key for the executor native library path.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#EXECUTOR_MEMORY">EXECUTOR_MEMORY</a></strong></code> +<div class="block">Configuration key for the executor memory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#SPARK_MASTER">SPARK_MASTER</a></strong></code> +<div class="block">The Spark master.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </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/launcher/SparkLauncher.html#SparkLauncher()">SparkLauncher</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#SparkLauncher(java.util.Map)">SparkLauncher</a></strong>(java.util.Map<java.lang.String,java.lang.String> env)</code> +<div class="block">Creates a launcher that will set the given environment variables in the child.</div> +</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/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#addAppArgs(java.lang.String...)">addAppArgs</a></strong>(java.lang.String... args)</code> +<div class="block">Adds command line arguments for the application.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#addFile(java.lang.String)">addFile</a></strong>(java.lang.String file)</code> +<div class="block">Adds a file to be submitted with the application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#addJar(java.lang.String)">addJar</a></strong>(java.lang.String jar)</code> +<div class="block">Adds a jar file to be submitted with the application.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#addPyFile(java.lang.String)">addPyFile</a></strong>(java.lang.String file)</code> +<div class="block">Adds a python file / zip / egg to be submitted with the application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#addSparkArg(java.lang.String)">addSparkArg</a></strong>(java.lang.String arg)</code> +<div class="block">Adds a no-value argument to the Spark invocation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#addSparkArg(java.lang.String, java.lang.String)">addSparkArg</a></strong>(java.lang.String name, + java.lang.String value)</code> +<div class="block">Adds an argument with a value to the Spark invocation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Process</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#launch()">launch</a></strong>()</code> +<div class="block">Launches a sub-process that will start the configured Spark application.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setAppName(java.lang.String)">setAppName</a></strong>(java.lang.String appName)</code> +<div class="block">Set the application name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setAppResource(java.lang.String)">setAppResource</a></strong>(java.lang.String resource)</code> +<div class="block">Set the main application resource.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setConf(java.lang.String, java.lang.String)">setConf</a></strong>(java.lang.String key, + java.lang.String value)</code> +<div class="block">Set a single configuration value for the application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setDeployMode(java.lang.String)">setDeployMode</a></strong>(java.lang.String mode)</code> +<div class="block">Set the deploy mode for the application.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setJavaHome(java.lang.String)">setJavaHome</a></strong>(java.lang.String javaHome)</code> +<div class="block">Set a custom JAVA_HOME for launching the Spark application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setMainClass(java.lang.String)">setMainClass</a></strong>(java.lang.String mainClass)</code> +<div class="block">Sets the application class name for Java/Scala applications.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setMaster(java.lang.String)">setMaster</a></strong>(java.lang.String master)</code> +<div class="block">Set the Spark master for the application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setPropertiesFile(java.lang.String)">setPropertiesFile</a></strong>(java.lang.String path)</code> +<div class="block">Set a custom properties file with Spark configuration for the application.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setSparkHome(java.lang.String)">setSparkHome</a></strong>(java.lang.String sparkHome)</code> +<div class="block">Set a custom Spark installation location for the application.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setVerbose(boolean)">setVerbose</a></strong>(boolean verbose)</code> +<div class="block">Enables verbose reporting for SparkSubmit.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="SPARK_MASTER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SPARK_MASTER</h4> +<pre>public static final java.lang.String SPARK_MASTER</pre> +<div class="block">The Spark master.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.SPARK_MASTER">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DRIVER_MEMORY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DRIVER_MEMORY</h4> +<pre>public static final java.lang.String DRIVER_MEMORY</pre> +<div class="block">Configuration key for the driver memory.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.DRIVER_MEMORY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DRIVER_EXTRA_CLASSPATH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DRIVER_EXTRA_CLASSPATH</h4> +<pre>public static final java.lang.String DRIVER_EXTRA_CLASSPATH</pre> +<div class="block">Configuration key for the driver class path.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.DRIVER_EXTRA_CLASSPATH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DRIVER_EXTRA_JAVA_OPTIONS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DRIVER_EXTRA_JAVA_OPTIONS</h4> +<pre>public static final java.lang.String DRIVER_EXTRA_JAVA_OPTIONS</pre> +<div class="block">Configuration key for the driver VM options.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.DRIVER_EXTRA_JAVA_OPTIONS">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DRIVER_EXTRA_LIBRARY_PATH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DRIVER_EXTRA_LIBRARY_PATH</h4> +<pre>public static final java.lang.String DRIVER_EXTRA_LIBRARY_PATH</pre> +<div class="block">Configuration key for the driver native library path.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.DRIVER_EXTRA_LIBRARY_PATH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EXECUTOR_MEMORY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EXECUTOR_MEMORY</h4> +<pre>public static final java.lang.String EXECUTOR_MEMORY</pre> +<div class="block">Configuration key for the executor memory.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.EXECUTOR_MEMORY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EXECUTOR_EXTRA_CLASSPATH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EXECUTOR_EXTRA_CLASSPATH</h4> +<pre>public static final java.lang.String EXECUTOR_EXTRA_CLASSPATH</pre> +<div class="block">Configuration key for the executor class path.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.EXECUTOR_EXTRA_CLASSPATH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EXECUTOR_EXTRA_JAVA_OPTIONS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EXECUTOR_EXTRA_JAVA_OPTIONS</h4> +<pre>public static final java.lang.String EXECUTOR_EXTRA_JAVA_OPTIONS</pre> +<div class="block">Configuration key for the executor VM options.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.EXECUTOR_EXTRA_JAVA_OPTIONS">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EXECUTOR_EXTRA_LIBRARY_PATH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EXECUTOR_EXTRA_LIBRARY_PATH</h4> +<pre>public static final java.lang.String EXECUTOR_EXTRA_LIBRARY_PATH</pre> +<div class="block">Configuration key for the executor native library path.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.EXECUTOR_EXTRA_LIBRARY_PATH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EXECUTOR_CORES"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EXECUTOR_CORES</h4> +<pre>public static final java.lang.String EXECUTOR_CORES</pre> +<div class="block">Configuration key for the number of executor CPU cores.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.spark.launcher.SparkLauncher.EXECUTOR_CORES">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SparkLauncher()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SparkLauncher</h4> +<pre>public SparkLauncher()</pre> +</li> +</ul> +<a name="SparkLauncher(java.util.Map)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SparkLauncher</h4> +<pre>public SparkLauncher(java.util.Map<java.lang.String,java.lang.String> env)</pre> +<div class="block">Creates a launcher that will set the given environment variables in the child.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>env</code> - Environment variables to set.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setJavaHome(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setJavaHome</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setJavaHome(java.lang.String javaHome)</pre> +<div class="block">Set a custom JAVA_HOME for launching the Spark application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javaHome</code> - Path to the JAVA_HOME to use.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</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/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setSparkHome(java.lang.String sparkHome)</pre> +<div class="block">Set a custom Spark installation location for the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sparkHome</code> - Path to the Spark installation to use.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="setPropertiesFile(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertiesFile</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setPropertiesFile(java.lang.String path)</pre> +<div class="block">Set a custom properties file with Spark configuration for the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - Path to custom properties file to use.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="setConf(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConf</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setConf(java.lang.String key, + java.lang.String value)</pre> +<div class="block">Set a single configuration value for the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Configuration key.</dd><dd><code>value</code> - The value to use.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</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/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setAppName(java.lang.String appName)</pre> +<div class="block">Set the application name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>appName</code> - Application name.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</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/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setMaster(java.lang.String master)</pre> +<div class="block">Set the Spark master for the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>master</code> - Spark master.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="setDeployMode(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDeployMode</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setDeployMode(java.lang.String mode)</pre> +<div class="block">Set the deploy mode for the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - Deploy mode.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="setAppResource(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAppResource</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setAppResource(java.lang.String resource)</pre> +<div class="block">Set the main application resource. This should be the location of a jar file for Scala/Java + applications, or a python script for PySpark applications.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resource</code> - Path to the main application resource.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="setMainClass(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMainClass</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setMainClass(java.lang.String mainClass)</pre> +<div class="block">Sets the application class name for Java/Scala applications.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mainClass</code> - Application's main class.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="addSparkArg(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSparkArg</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> addSparkArg(java.lang.String arg)</pre> +<div class="block">Adds a no-value argument to the Spark invocation. If the argument is known, this method + validates whether the argument is indeed a no-value argument, and throws an exception + otherwise. + <p> + Use this method with caution. It is possible to create an invalid Spark command by passing + unknown arguments to this method, since those are allowed for forward compatibility.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>arg</code> - Argument to add.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="addSparkArg(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSparkArg</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> addSparkArg(java.lang.String name, + java.lang.String value)</pre> +<div class="block">Adds an argument with a value to the Spark invocation. If the argument name corresponds to + a known argument, the code validates that the argument actually expects a value, and throws + an exception otherwise. + <p> + It is safe to add arguments modified by other methods in this class (such as + <a href="../../../../org/apache/spark/launcher/SparkLauncher.html#setMaster(java.lang.String)"><code>setMaster(String)</code></a> - the last invocation will be the one to take effect. + <p> + Use this method with caution. It is possible to create an invalid Spark command by passing + unknown arguments to this method, since those are allowed for forward compatibility.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of argument to add.</dd><dd><code>value</code> - Value of the argument.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="addAppArgs(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAppArgs</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> addAppArgs(java.lang.String... args)</pre> +<div class="block">Adds command line arguments for the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - Arguments to pass to the application's main class.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="addJar(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addJar</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> addJar(java.lang.String jar)</pre> +<div class="block">Adds a jar file to be submitted with the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>jar</code> - Path to the jar file.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="addFile(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addFile</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> addFile(java.lang.String file)</pre> +<div class="block">Adds a file to be submitted with the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - Path to the file.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="addPyFile(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPyFile</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> addPyFile(java.lang.String file)</pre> +<div class="block">Adds a python file / zip / egg to be submitted with the application.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - Path to the file.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="setVerbose(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVerbose</h4> +<pre>public <a href="../../../../org/apache/spark/launcher/SparkLauncher.html" title="class in org.apache.spark.launcher">SparkLauncher</a> setVerbose(boolean verbose)</pre> +<div class="block">Enables verbose reporting for SparkSubmit.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verbose</code> - Whether to enable verbose output.</dd> +<dt><span class="strong">Returns:</span></dt><dd>This launcher.</dd></dl> +</li> +</ul> +<a name="launch()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>launch</h4> +<pre>public java.lang.Process launch() + throws java.io.IOException</pre> +<div class="block">Launches a sub-process that will start the configured Spark application.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A process handle for the Spark app.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/spark/launcher/SparkLauncher.html" target="_top">Frames</a></li> +<li><a href="SparkLauncher.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> |