blob: 69c54da25a3bacc47343830cd2647b426f1e661c [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_181-google-v7) on Wed Aug 14 17:37:15 PDT 2019 -->
<title>org.apache.beam.runners.direct (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<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.direct (Apache Beam 2.15.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><a href="../../../../../org/apache/beam/runners/dataflow/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/beam/runners/flink/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/direct/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.direct</h1>
<div class="docSummary">
<div class="block">Defines the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.DirectRunner.html" title="class in org.apache.beam.sdk.options"><code>PipelineOptions.DirectRunner</code></a> which executes both
Bounded and Unbounded <code>Pipelines</code> on the local machine.</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/direct/Clock.html" title="interface in org.apache.beam.runners.direct">Clock</a></td>
<td class="colLast">
<div class="block">Access to the current time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/DirectOptions.html" title="interface in org.apache.beam.runners.direct">DirectOptions</a></td>
<td class="colLast">
<div class="block">Options that can be used to configure the <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/DirectTestOptions.html" title="interface in org.apache.beam.runners.direct">DirectTestOptions</a></td>
<td class="colLast">
<div class="block">Internal-only options for tweaking the behavior of the <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner</code></a> in ways that users
should never do.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/ExecutableGraph.html" title="interface in org.apache.beam.runners.direct">ExecutableGraph</a>&lt;ExecutableT,CollectionT&gt;</td>
<td class="colLast">
<div class="block">The interface that enables querying of a graph of independently executable stages and the inputs
and outputs of those stages.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/TransformExecutor.html" title="interface in org.apache.beam.runners.direct">TransformExecutor</a></td>
<td class="colLast">
<div class="block">A <code>Runnable</code> that will execute a <code>PTransform</code> on some bundle of input.</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/direct/DirectOptions.AvailableParallelismFactory.html" title="class in org.apache.beam.runners.direct">DirectOptions.AvailableParallelismFactory</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/sdk/options/DefaultValueFactory.html" title="interface in org.apache.beam.sdk.options"><code>DefaultValueFactory</code></a> that returns the result of <code>Runtime.availableProcessors()</code>
from the <a href="../../../../../org/apache/beam/runners/direct/DirectOptions.AvailableParallelismFactory.html#create-org.apache.beam.sdk.options.PipelineOptions-"><code>DirectOptions.AvailableParallelismFactory.create(PipelineOptions)</code></a> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/DirectRegistrar.html" title="class in org.apache.beam.runners.direct">DirectRegistrar</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/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/DirectRegistrar.Options.html" title="class in org.apache.beam.runners.direct">DirectRegistrar.Options</a></td>
<td class="colLast">
<div class="block">Registers the <a href="../../../../../org/apache/beam/runners/direct/DirectOptions.html" title="interface in org.apache.beam.runners.direct"><code>DirectOptions</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/DirectRegistrar.Runner.html" title="class in org.apache.beam.runners.direct">DirectRegistrar.Runner</a></td>
<td class="colLast">
<div class="block">Registers the <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct">DirectRunner</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 executes a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> within the process that constructed the
<a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a></td>
<td class="colLast">
<div class="block">The result of running a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> with the <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/ParDoMultiOverrideFactory.html" title="class in org.apache.beam.runners.direct">ParDoMultiOverrideFactory</a>&lt;InputT,OutputT&gt;</td>
<td class="colLast">
<div class="block">A <code>PTransformOverrideFactory</code> that provides overrides for applications of a <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a>
in the direct runner.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.html" title="class in org.apache.beam.runners.direct">WatermarkManager</a>&lt;ExecutableT,CollectionT&gt;</td>
<td class="colLast">
<div class="block">Manages watermarks of <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a> and input and output watermarks of <code>AppliedPTransforms</code> to provide event-time and completion tracking for in-memory
execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.FiredTimers.html" title="class in org.apache.beam.runners.direct">WatermarkManager.FiredTimers</a>&lt;ExecutableT&gt;</td>
<td class="colLast">
<div class="block">A pair of <code>TimerInternals.TimerData</code> and key which can be delivered to the appropriate <code>AppliedPTransform</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate</a></td>
<td class="colLast">
<div class="block">A collection of newly set, deleted, and completed timers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.TimerUpdateBuilder.html" title="class in org.apache.beam.runners.direct">WatermarkManager.TimerUpdate.TimerUpdateBuilder</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/runners/direct/WatermarkManager.TimerUpdate.html" title="class in org.apache.beam.runners.direct"><code>WatermarkManager.TimerUpdate</code></a> builder that needs to be provided with set timers and deleted timers.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.runners.direct Description">Package org.apache.beam.runners.direct Description</h2>
<div class="block">Defines the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.DirectRunner.html" title="class in org.apache.beam.sdk.options"><code>PipelineOptions.DirectRunner</code></a> which executes both
Bounded and Unbounded <code>Pipelines</code> on the local machine.
<p>See <code>org.apache.beam.sdk.runners</code> for more information about Pipeline Runners.</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/dataflow/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/beam/runners/flink/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/runners/direct/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>