blob: cb4fcfbe766962b25b8b97f82876aca0360b160e [file] [log] [blame]
<!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 (1.8.0_161-google-v7) on Thu Oct 18 16:14:36 PDT 2018 -->
<title>org.apache.beam.runners.apex (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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.apex (Apache Beam 2.8.0-SNAPSHOT)";
}
}
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>Prev&nbsp;Package</li>
<li><a href="../../../../../org/apache/beam/runners/dataflow/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/apex/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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&nbsp;org.apache.beam.runners.apex</h1>
<div class="docSummary">
<div class="block">Implementation of the Beam runner for Apache Apex.</div>
</div>
<p>See:&nbsp;<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">&nbsp;</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/apex/ApexPipelineOptions.html" title="interface in org.apache.beam.runners.apex">ApexPipelineOptions</a></td>
<td class="colLast">
<div class="block">Options that configure the Apex pipeline.</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">&nbsp;</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/apex/ApexRunner.html" title="class in org.apache.beam.runners.apex">ApexRunner</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a> that translates the pipeline to an Apex DAG and executes it on an Apex
cluster.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunner.CreateApexPCollectionView.html" title="class in org.apache.beam.runners.apex">ApexRunner.CreateApexPCollectionView</a>&lt;ElemT,ViewT&gt;</td>
<td class="colLast">
<div class="block">Creates a primitive <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.html" title="class in org.apache.beam.runners.apex">ApexRunnerRegistrar</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/apex/ApexRunner.html" title="class in org.apache.beam.runners.apex"><code>ApexRunner</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.Options.html" title="class in org.apache.beam.runners.apex">ApexRunnerRegistrar.Options</a></td>
<td class="colLast">
<div class="block">Registers the <a href="../../../../../org/apache/beam/runners/apex/ApexPipelineOptions.html" title="interface in org.apache.beam.runners.apex"><code>ApexPipelineOptions</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.Runner.html" title="class in org.apache.beam.runners.apex">ApexRunnerRegistrar.Runner</a></td>
<td class="colLast">
<div class="block">Registers the <a href="../../../../../org/apache/beam/runners/apex/ApexRunner.html" title="class in org.apache.beam.runners.apex"><code>ApexRunner</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerResult.html" title="class in org.apache.beam.runners.apex">ApexRunnerResult</a></td>
<td class="colLast">
<div class="block">Result of executing a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> with Apex in embedded mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.html" title="class in org.apache.beam.runners.apex">ApexYarnLauncher</a></td>
<td class="colLast">
<div class="block">Proxy to launch the YARN application through the hadoop script to run in the pre-configured
environment (class path, configuration, native libraries etc.).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.LaunchParams.html" title="class in org.apache.beam.runners.apex">ApexYarnLauncher.LaunchParams</a></td>
<td class="colLast">
<div class="block">Launch parameters that will be serialized and passed to the child process.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.ProcessWatcher.html" title="class in org.apache.beam.runners.apex">ApexYarnLauncher.ProcessWatcher</a></td>
<td class="colLast">
<div class="block">Starts a command and waits for it to complete.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/TestApexRunner.html" title="class in org.apache.beam.runners.apex">TestApexRunner</a></td>
<td class="colLast">
<div class="block">Apex <a href="../../../../../org/apache/beam/sdk/PipelineRunner.html" title="class in org.apache.beam.sdk"><code>PipelineRunner</code></a> for testing.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.runners.apex Description">Package org.apache.beam.runners.apex Description</h2>
<div class="block">Implementation of the Beam runner for Apache Apex.</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>Prev&nbsp;Package</li>
<li><a href="../../../../../org/apache/beam/runners/dataflow/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/apex/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>