| <!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 --> |
| <title>org.apache.beam.runners.spark (Apache Beam 2.47.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.beam.runners.spark (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>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/beam/runners/portability/testing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/runners/spark/coders/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/spark/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.beam.runners.spark</h1> |
| <div class="docSummary"> |
| <div class="block">Internal implementation of the Beam runner for Apache Spark.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkCommonPipelineOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Spark runner <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> handles Spark execution-related configurations, such as the |
| master address, and other user-related knobs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkContextOptions.html" title="interface in org.apache.beam.runners.spark">SparkContextOptions</a></td> |
| <td class="colLast"> |
| <div class="block">A custom <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> to work with properties related to <code>JavaSparkContext</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkPipelineOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Spark runner <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> handles Spark execution-related configurations, such as the |
| master address, batch-interval, and other user-related knobs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkPortableStreamingPipelineOptions.html" title="interface in org.apache.beam.runners.spark">SparkPortableStreamingPipelineOptions</a></td> |
| <td class="colLast"> |
| <div class="block">Pipeline options specific to the Spark portable runner running a streaming job.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/TestSparkPipelineOptions.html" title="interface in org.apache.beam.runners.spark">TestSparkPipelineOptions</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html" title="interface in org.apache.beam.runners.spark"><code>SparkPipelineOptions</code></a> for tests.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.StorageLevelFactory.html" title="class in org.apache.beam.runners.spark">SparkCommonPipelineOptions.StorageLevelFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Returns Spark's default storage level for the Dataset or RDD API based on the respective |
| runner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkCommonPipelineOptions.TmpCheckpointDirFactory.html" title="class in org.apache.beam.runners.spark">SparkCommonPipelineOptions.TmpCheckpointDirFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Returns the default checkpoint directory of /tmp/${job.name}.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkContextOptions.EmptyListenersList.html" title="class in org.apache.beam.runners.spark">SparkContextOptions.EmptyListenersList</a></td> |
| <td class="colLast"> |
| <div class="block">Returns an empty list, to avoid handling null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkJobInvoker.html" title="class in org.apache.beam.runners.spark">SparkJobInvoker</a></td> |
| <td class="colLast"> |
| <div class="block">Creates a job invocation to manage the Spark runner's execution of a portable pipeline.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkJobServerDriver.html" title="class in org.apache.beam.runners.spark">SparkJobServerDriver</a></td> |
| <td class="colLast"> |
| <div class="block">Driver program that starts a job server for the Spark runner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkJobServerDriver.SparkServerConfiguration.html" title="class in org.apache.beam.runners.spark">SparkJobServerDriver.SparkServerConfiguration</a></td> |
| <td class="colLast"> |
| <div class="block">Spark runner-specific Configuration for the jobServer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkNativePipelineVisitor.html" title="class in org.apache.beam.runners.spark">SparkNativePipelineVisitor</a></td> |
| <td class="colLast"> |
| <div class="block">Pipeline visitor for translating a Beam pipeline into equivalent Spark operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineResult.html" title="class in org.apache.beam.runners.spark">SparkPipelineResult</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a Spark pipeline execution result.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkPipelineRunner.html" title="class in org.apache.beam.runners.spark">SparkPipelineRunner</a></td> |
| <td class="colLast"> |
| <div class="block">Runs a portable pipeline on Apache Spark.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark">SparkRunner</a></td> |
| <td class="colLast"> |
| <div class="block">The SparkRunner translate operations defined on a pipeline to a representation executable by |
| Spark, and then submitting the job to Spark to be executed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkRunner.Evaluator.html" title="class in org.apache.beam.runners.spark">SparkRunner.Evaluator</a></td> |
| <td class="colLast"> |
| <div class="block">Evaluator on the pipeline.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.html" title="class in org.apache.beam.runners.spark">SparkRunnerDebugger</a></td> |
| <td class="colLast"> |
| <div class="block">Pipeline runner which translates a Beam pipeline into equivalent Spark operations, without |
| running them.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.DebugSparkPipelineResult.html" title="class in org.apache.beam.runners.spark">SparkRunnerDebugger.DebugSparkPipelineResult</a></td> |
| <td class="colLast"> |
| <div class="block">PipelineResult of running a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> using <a href="../../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.html" title="class in org.apache.beam.runners.spark"><code>SparkRunnerDebugger</code></a> Use <a href="../../../../../org/apache/beam/runners/spark/SparkRunnerDebugger.DebugSparkPipelineResult.html#getDebugString--"><code>SparkRunnerDebugger.DebugSparkPipelineResult.getDebugString()</code></a> to get a <code>String</code> representation of the <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> translated into |
| Spark native operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerRegistrar.html" title="class in org.apache.beam.runners.spark">SparkRunnerRegistrar</a></td> |
| <td class="colLast"> |
| <div class="block">Contains the <code>PipelineRunnerRegistrar</code> and <a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptionsRegistrar</code></a> for the <a href="../../../../../org/apache/beam/runners/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark"><code>SparkRunner</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerRegistrar.Options.html" title="class in org.apache.beam.runners.spark">SparkRunnerRegistrar.Options</a></td> |
| <td class="colLast"> |
| <div class="block">Registers the <a href="../../../../../org/apache/beam/runners/spark/SparkPipelineOptions.html" title="interface in org.apache.beam.runners.spark"><code>SparkPipelineOptions</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/SparkRunnerRegistrar.Runner.html" title="class in org.apache.beam.runners.spark">SparkRunnerRegistrar.Runner</a></td> |
| <td class="colLast"> |
| <div class="block">Registers the <a href="../../../../../org/apache/beam/runners/spark/SparkRunner.html" title="class in org.apache.beam.runners.spark"><code>SparkRunner</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/TestSparkPipelineOptions.DefaultStopPipelineWatermarkFactory.html" title="class in org.apache.beam.runners.spark">TestSparkPipelineOptions.DefaultStopPipelineWatermarkFactory</a></td> |
| <td class="colLast"> |
| <div class="block">A factory to provide the default watermark to stop a pipeline that reads from an unbounded |
| source.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/beam/runners/spark/TestSparkRunner.html" title="class in org.apache.beam.runners.spark">TestSparkRunner</a></td> |
| <td class="colLast"> |
| <div class="block">The SparkRunner translate operations defined on a pipeline to a representation executable by |
| Spark, and then submitting the job to Spark to be executed.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.runners.spark Description">Package org.apache.beam.runners.spark Description</h2> |
| <div class="block">Internal implementation of the Beam runner for Apache Spark.</div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>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/beam/runners/portability/testing/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/beam/runners/spark/coders/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/runners/spark/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
