http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRegistrar.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRegistrar.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRegistrar.html new file mode 100644 index 0000000..7488ddc --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRegistrar.html @@ -0,0 +1,224 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>DirectRegistrar</title> +<meta name="date" content="2017-03-08"> +<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="DirectRegistrar"; + } + } + 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><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/beam/runners/direct/DirectOptions.AvailableParallelismFactory.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/DirectRegistrar.Options.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/DirectRegistrar.html" target="_top">Frames</a></li> +<li><a href="DirectRegistrar.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.beam.runners.direct</div> +<h2 title="Class DirectRegistrar" class="title">Class DirectRegistrar</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.direct.DirectRegistrar</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DirectRegistrar</span> +extends java.lang.Object</pre> +<div class="block">Contains the <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunnerRegistrar.html" title="interface in org.apache.beam.sdk.runners"><code>PipelineRunnerRegistrar</code></a> 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> +</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRegistrar.Options.html" title="class in org.apache.beam.runners.direct">DirectRegistrar.Options</a></span></code> +<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"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRegistrar.Runner.html" title="class in org.apache.beam.runners.direct">DirectRegistrar.Runner</a></span></code> +<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> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><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/beam/runners/direct/DirectOptions.AvailableParallelismFactory.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/DirectRegistrar.Options.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/DirectRegistrar.html" target="_top">Frames</a></li> +<li><a href="DirectRegistrar.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html new file mode 100644 index 0000000..0f11e31 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html @@ -0,0 +1,408 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>DirectRunner.DirectPipelineResult</title> +<meta name="date" content="2017-03-08"> +<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="DirectRunner.DirectPipelineResult"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><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/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" target="_top">Frames</a></li> +<li><a href="DirectRunner.DirectPipelineResult.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.beam.runners.direct</div> +<h2 title="Class DirectRunner.DirectPipelineResult" class="title">Class DirectRunner.DirectPipelineResult</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.direct.DirectRunner.DirectPipelineResult</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct">DirectRunner</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">DirectRunner.DirectPipelineResult</span> +extends java.lang.Object +implements <a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></pre> +<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>. + + <p>Throws <code>UnsupportedOperationException</code> for all methods.</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.org.apache.beam.sdk.PipelineResult"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.beam.sdk.<a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html#cancel--">cancel</a></span>()</code> +<div class="block">Cancels the pipeline execution.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/AggregatorValues.html" title="class in org.apache.beam.sdk">AggregatorValues</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html#getAggregatorValues-org.apache.beam.sdk.transforms.Aggregator-">getAggregatorValues</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><?,T> aggregator)</code> +<div class="block">Retrieves the current value of the provided <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html#getState--">getState</a></span>()</code> +<div class="block">Retrieves the current state of the pipeline execution.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html#metrics--">metrics</a></span>()</code> +<div class="block">Return the object to access metrics from the pipeline.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html#waitUntilFinish--">waitUntilFinish</a></span>()</code> +<div class="block">Blocks until the <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> execution represented by this + <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner.DirectPipelineResult</code></a> is complete, returning the terminal state.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html#waitUntilFinish-org.joda.time.Duration-">waitUntilFinish</a></span>(<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</code> +<div class="block">Waits until the pipeline finishes and returns the final status.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getState--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getState</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> getState()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getState--">PipelineResult</a></code></span></div> +<div class="block">Retrieves the current state of the pipeline execution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getState--">getState</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk"><code>PipelineResult.State</code></a> representing the state of this pipeline.</dd> +</dl> +</li> +</ul> +<a name="getAggregatorValues-org.apache.beam.sdk.transforms.Aggregator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAggregatorValues</h4> +<pre>public <T> <a href="../../../../../org/apache/beam/sdk/AggregatorValues.html" title="class in org.apache.beam.sdk">AggregatorValues</a><T> getAggregatorValues(<a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><?,T> aggregator) + throws <a href="../../../../../org/apache/beam/sdk/AggregatorRetrievalException.html" title="class in org.apache.beam.sdk">AggregatorRetrievalException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getAggregatorValues-org.apache.beam.sdk.transforms.Aggregator-">PipelineResult</a></code></span></div> +<div class="block">Retrieves the current value of the provided <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#getAggregatorValues-org.apache.beam.sdk.transforms.Aggregator-">getAggregatorValues</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aggregator</code> - the <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> to retrieve values for.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current values of the <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a>, + which may be empty if there are no values yet.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/AggregatorRetrievalException.html" title="class in org.apache.beam.sdk">AggregatorRetrievalException</a></code> - if the <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> values could not be retrieved.</dd> +</dl> +</li> +</ul> +<a name="metrics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>metrics</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/metrics/MetricResults.html" title="class in org.apache.beam.sdk.metrics">MetricResults</a> metrics()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#metrics--">PipelineResult</a></code></span></div> +<div class="block">Return the object to access metrics from the pipeline.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#metrics--">metrics</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +</dl> +</li> +</ul> +<a name="waitUntilFinish--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>waitUntilFinish</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> waitUntilFinish()</pre> +<div class="block">Blocks until the <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> execution represented by this + <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner.DirectPipelineResult</code></a> is complete, returning the terminal state. + + <p>If the pipeline terminates abnormally by throwing an exception, this will rethrow the + exception. Future calls to <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html#getState--"><code>getState()</code></a> will return + <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html#FAILED"><code>PipelineResult.State.FAILED</code></a>. + + <p>NOTE: if the <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> contains an <a href="../../../../../org/apache/beam/sdk/values/PCollection.IsBounded.html#UNBOUNDED"><code>unbounded</code></a> + <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>, and the <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><code>PipelineRunner</code></a> was created with + <a href="../../../../../org/apache/beam/runners/direct/DirectOptions.html#isShutdownUnboundedProducersWithMaxWatermark--"><code>DirectOptions.isShutdownUnboundedProducersWithMaxWatermark()</code></a> set to false, + this method will never return. + + <p>See also <code>PipelineExecutor.awaitCompletion()</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#waitUntilFinish--">waitUntilFinish</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The final state of the pipeline.</dd> +</dl> +</li> +</ul> +<a name="cancel--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancel</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> cancel() + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#cancel--">PipelineResult</a></code></span></div> +<div class="block">Cancels the pipeline execution.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#cancel--">cancel</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if there is a problem executing the cancel request.</dd> +</dl> +</li> +</ul> +<a name="waitUntilFinish-org.joda.time.Duration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>waitUntilFinish</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/PipelineResult.State.html" title="enum in org.apache.beam.sdk">PipelineResult.State</a> waitUntilFinish(<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> duration)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#waitUntilFinish-org.joda.time.Duration-">PipelineResult</a></code></span></div> +<div class="block">Waits until the pipeline finishes and returns the final status. + It times out after the given duration.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html#waitUntilFinish-org.joda.time.Duration-">waitUntilFinish</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>duration</code> - The time to wait for the pipeline to finish. + Provide a value less than 1 ms for an infinite wait.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The final state of the pipeline or null on timeout.</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> +<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><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/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" target="_top">Frames</a></li> +<li><a href="DirectRunner.DirectPipelineResult.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.html new file mode 100644 index 0000000..21e4052 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/DirectRunner.html @@ -0,0 +1,300 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>DirectRunner</title> +<meta name="date" content="2017-03-08"> +<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="DirectRunner"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><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/beam/runners/direct/DirectRegistrar.Runner.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/DirectRunner.html" target="_top">Frames</a></li> +<li><a href="DirectRunner.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><a href="#nested.class.summary">Nested</a> | </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.beam.runners.direct</div> +<h2 title="Class DirectRunner" class="title">Class DirectRunner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners">org.apache.beam.sdk.runners.PipelineRunner</a><<a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.direct.DirectRunner</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DirectRunner</span> +extends <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners">PipelineRunner</a><<a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a>></pre> +<div class="block">An In-Memory implementation of the Dataflow Programming Model. Supports Unbounded + <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollections</code></a>.</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a></span></code> +<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> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct">DirectRunner</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html#fromOptions-org.apache.beam.sdk.options.PipelineOptions-">fromOptions</a></span>(<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/DirectOptions.html" title="interface in org.apache.beam.runners.direct">DirectOptions</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html#getPipelineOptions--">getPipelineOptions</a></span>()</code> +<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> used to create this <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 id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html#run-org.apache.beam.sdk.Pipeline-">run</a></span>(<a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</code> +<div class="block">Processes the given Pipeline, returning the results.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fromOptions-org.apache.beam.sdk.options.PipelineOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromOptions</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct">DirectRunner</a> fromOptions(<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a> options)</pre> +</li> +</ul> +<a name="getPipelineOptions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPipelineOptions</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/direct/DirectOptions.html" title="interface in org.apache.beam.runners.direct">DirectOptions</a> getPipelineOptions()</pre> +<div class="block">Returns the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><code>PipelineOptions</code></a> used to create this <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.html" title="class in org.apache.beam.runners.direct"><code>DirectRunner</code></a>.</div> +</li> +</ul> +<a name="run-org.apache.beam.sdk.Pipeline-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>run</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a> run(<a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk">Pipeline</a> pipeline)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html#run-org.apache.beam.sdk.Pipeline-">PipelineRunner</a></code></span></div> +<div class="block">Processes the given Pipeline, returning the results.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html#run-org.apache.beam.sdk.Pipeline-">run</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners">PipelineRunner</a><<a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct">DirectRunner.DirectPipelineResult</a>></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> +<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><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/beam/runners/direct/DirectRegistrar.Runner.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/DirectRunner.html" target="_top">Frames</a></li> +<li><a href="DirectRunner.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><a href="#nested.class.summary">Nested</a> | </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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ExecutorServiceFactory.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ExecutorServiceFactory.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ExecutorServiceFactory.html new file mode 100644 index 0000000..325f854 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ExecutorServiceFactory.html @@ -0,0 +1,226 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>ExecutorServiceFactory</title> +<meta name="date" content="2017-03-08"> +<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="ExecutorServiceFactory"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><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/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/ExecutorServiceFactory.html" target="_top">Frames</a></li> +<li><a href="ExecutorServiceFactory.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.beam.runners.direct</div> +<h2 title="Interface ExecutorServiceFactory" class="title">Interface ExecutorServiceFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ExecutorServiceFactory</span></pre> +<div class="block">A factory that creates <code>ExecutorServices</code>. + <code>ExecutorServices</code> created by this factory should be independent of one + another (e.g., if any executor is shut down the remaining executors should continue to process + work).</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.util.concurrent.ExecutorService</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ExecutorServiceFactory.html#create--">create</a></span>()</code> +<div class="block">Create a new <code>ExecutorService</code>.</div> +</td> +</tr> +</table> +</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="create--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre>java.util.concurrent.ExecutorService create()</pre> +<div class="block">Create a new <code>ExecutorService</code>.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><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/beam/runners/direct/DirectRunner.DirectPipelineResult.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="class in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/ExecutorServiceFactory.html" target="_top">Frames</a></li> +<li><a href="ExecutorServiceFactory.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ForwardingPTransform.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ForwardingPTransform.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ForwardingPTransform.html new file mode 100644 index 0000000..3c10b09 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/direct/ForwardingPTransform.html @@ -0,0 +1,458 @@ +<!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_112-google-v7) on Wed Mar 08 17:12:54 PST 2017 --> +<title>ForwardingPTransform</title> +<meta name="date" content="2017-03-08"> +<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="ForwardingPTransform"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</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><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/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/ForwardingPTransform.html" target="_top">Frames</a></li> +<li><a href="ForwardingPTransform.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="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">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>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.beam.runners.direct</div> +<h2 title="Class ForwardingPTransform" class="title">Class ForwardingPTransform<InputT extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,OutputT extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><InputT,OutputT></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.direct.ForwardingPTransform<InputT,OutputT></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">ForwardingPTransform<InputT extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,OutputT extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>></span> +extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><InputT,OutputT></pre> +<div class="block">A base class for implementing <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> overrides, which behave identically to the + delegate transform but with overridden methods. Implementors are required to implement + <a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#delegate--"><code>delegate()</code></a>, which returns the object to forward calls to, and <a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#expand-InputT-"><code>expand(PInput)</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.direct.ForwardingPTransform">Serialized Form</a></dd> +</dl> +</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#ForwardingPTransform--">ForwardingPTransform</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a>,<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#delegate--">delegate</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#expand-InputT-">expand</a></span>(<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> input)</code> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><T> <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">getDefaultOutputCoder</a></span>(<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> input, + <a href="../../../../../org/apache/beam/sdk/values/TypedPValue.html" title="class in org.apache.beam.sdk.values">TypedPValue</a><T> output)</code> +<div class="block">Returns the default <code>Coder</code> to use for the given output of + this single-output <code>PTransform</code> when applied to the given input.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#getName--">getName</a></span>()</code> +<div class="block">Returns the transform name.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</code> +<div class="block">Register display data for the given transform or component.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html#validate-InputT-">validate</a></span>(<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> input)</code> +<div class="block">Called before invoking apply (which may be intercepted by the runner) to + verify this transform is fully specified and applicable to the specified + input.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a></code></li> +</ul> +<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, wait, wait, wait</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="ForwardingPTransform--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForwardingPTransform</h4> +<pre>public ForwardingPTransform()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="delegate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delegate</h4> +<pre>protected abstract <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a>,<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a>> delegate()</pre> +</li> +</ul> +<a name="expand-org.apache.beam.sdk.values.PInput-"> +<!-- --> +</a><a name="expand-InputT-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>expand</h4> +<pre>public <a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a> expand(<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> input)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> +<div class="block">Applies this <code>PTransform</code> on the given <code>InputT</code>, and returns its + <code>Output</code>. + + <p>Composite transforms, which are defined in terms of other transforms, + should return the output of one of the composed transforms. Non-composite + transforms, which do not apply any transforms internally, should return + a new unbound output and register evaluators (via backend-specific + registration methods).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>></code></dd> +</dl> +</li> +</ul> +<a name="validate-org.apache.beam.sdk.values.PInput-"> +<!-- --> +</a><a name="validate-InputT-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validate</h4> +<pre>public void validate(<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> input)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-InputT-">PTransform</a></code></span></div> +<div class="block">Called before invoking apply (which may be intercepted by the runner) to + verify this transform is fully specified and applicable to the specified + input. + + <p>By default, does nothing.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-InputT-">validate</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>></code></dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">PTransform</a></code></span></div> +<div class="block">Returns the transform name. + + <p>This name is provided by the transform creator and is not required to be unique.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>></code></dd> +</dl> +</li> +</ul> +<a name="getDefaultOutputCoder-org.apache.beam.sdk.values.PInput-org.apache.beam.sdk.values.TypedPValue-"> +<!-- --> +</a><a name="getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultOutputCoder</h4> +<pre>public <T> <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T> getDefaultOutputCoder(<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> input, + <a href="../../../../../org/apache/beam/sdk/values/TypedPValue.html" title="class in org.apache.beam.sdk.values">TypedPValue</a><T> output) + throws <a href="../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">PTransform</a></code></span></div> +<div class="block">Returns the default <code>Coder</code> to use for the given output of + this single-output <code>PTransform</code> when applied to the given input. + + <p>By default, always throws.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">getDefaultOutputCoder</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></code> - if none can be inferred.</dd> +</dl> +</li> +</ul> +<a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>populateDisplayData</h4> +<pre>public void populateDisplayData(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">PTransform</a></code></span></div> +<div class="block">Register display data for the given transform or component. + + <p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect + display data via <a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call + <code>super.populateDisplayData(builder)</code> in order to register display data in the current + namespace, but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use + the namespace of the subcomponent. + + <p>By default, does not register any display data. Implementors may override this method + to provide their own display data.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">InputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../org/apache/beam/runners/direct/ForwardingPTransform.html" title="type parameter in ForwardingPTransform">OutputT</a> extends <a href="../../../../../org/apache/beam/sdk/values/POutput.html" title="interface in org.apache.beam.sdk.values">POutput</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>builder</code> - The builder to populate with display data.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></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> +<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><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/beam/runners/direct/ExecutorServiceFactory.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/direct/ModelEnforcement.html" title="interface in org.apache.beam.runners.direct"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/direct/ForwardingPTransform.html" target="_top">Frames</a></li> +<li><a href="ForwardingPTransform.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="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">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>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 ======= --> +</body> +</html>