http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-frame.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-frame.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-frame.html new file mode 100644 index 0000000..b9d24a3 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-frame.html @@ -0,0 +1,33 @@ +<!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:57 PST 2017 --> +<title>org.apache.beam.runners.apex</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> +<h1 class="bar"><a href="../../../../../org/apache/beam/runners/apex/package-summary.html" target="classFrame">org.apache.beam.runners.apex</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="ApexPipelineOptions.html" title="interface in org.apache.beam.runners.apex" target="classFrame"><span class="interfaceName">ApexPipelineOptions</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ApexRunner.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexRunner</a></li> +<li><a href="ApexRunner.CreateApexPCollectionView.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexRunner.CreateApexPCollectionView</a></li> +<li><a href="ApexRunnerRegistrar.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexRunnerRegistrar</a></li> +<li><a href="ApexRunnerRegistrar.Options.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexRunnerRegistrar.Options</a></li> +<li><a href="ApexRunnerRegistrar.Runner.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexRunnerRegistrar.Runner</a></li> +<li><a href="ApexRunnerResult.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexRunnerResult</a></li> +<li><a href="ApexYarnLauncher.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexYarnLauncher</a></li> +<li><a href="ApexYarnLauncher.LaunchParams.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexYarnLauncher.LaunchParams</a></li> +<li><a href="ApexYarnLauncher.ProcessWatcher.html" title="class in org.apache.beam.runners.apex" target="classFrame">ApexYarnLauncher.ProcessWatcher</a></li> +<li><a href="TestApexRunner.html" title="class in org.apache.beam.runners.apex" target="classFrame">TestApexRunner</a></li> +</ul> +</div> +</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/apex/package-summary.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-summary.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-summary.html new file mode 100644 index 0000000..837d83b --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-summary.html @@ -0,0 +1,225 @@ +<!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:57 PST 2017 --> +<title>org.apache.beam.runners.apex</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="org.apache.beam.runners.apex"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Package</li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/apex/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.beam.runners.apex</h1> +<div class="docSummary"> +<div class="block">Implementation of the Beam runner for Apache Apex.</div> +</div> +<p>See: <a href="#package.description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexPipelineOptions.html" title="interface in org.apache.beam.runners.apex">ApexPipelineOptions</a></td> +<td class="colLast"> +<div class="block">Options that configure the Apex pipeline.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunner.html" title="class in org.apache.beam.runners.apex">ApexRunner</a></td> +<td class="colLast"> +<div class="block">A <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><code>PipelineRunner</code></a> that translates the + pipeline to an Apex DAG and executes it on an Apex cluster.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunner.CreateApexPCollectionView.html" title="class in org.apache.beam.runners.apex">ApexRunner.CreateApexPCollectionView</a><ElemT,ViewT></td> +<td class="colLast"> +<div class="block">Creates a primitive <a href="../../../../../org/apache/beam/sdk/values/PCollectionView.html" title="interface in org.apache.beam.sdk.values"><code>PCollectionView</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.html" title="class in org.apache.beam.runners.apex">ApexRunnerRegistrar</a></td> +<td class="colLast"> +<div class="block">Contains the <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/apex/ApexRunner.html" title="class in org.apache.beam.runners.apex"><code>ApexRunner</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.Options.html" title="class in org.apache.beam.runners.apex">ApexRunnerRegistrar.Options</a></td> +<td class="colLast"> +<div class="block">Registers the <a href="../../../../../org/apache/beam/runners/apex/ApexPipelineOptions.html" title="interface in org.apache.beam.runners.apex"><code>ApexPipelineOptions</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.Runner.html" title="class in org.apache.beam.runners.apex">ApexRunnerRegistrar.Runner</a></td> +<td class="colLast"> +<div class="block">Registers the <a href="../../../../../org/apache/beam/runners/apex/ApexRunner.html" title="class in org.apache.beam.runners.apex"><code>ApexRunner</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexRunnerResult.html" title="class in org.apache.beam.runners.apex">ApexRunnerResult</a></td> +<td class="colLast"> +<div class="block">Result of executing a <a href="../../../../../org/apache/beam/sdk/Pipeline.html" title="class in org.apache.beam.sdk"><code>Pipeline</code></a> with Apex in embedded mode.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.html" title="class in org.apache.beam.runners.apex">ApexYarnLauncher</a></td> +<td class="colLast"> +<div class="block">Proxy to launch the YARN application through the hadoop script to run in the + pre-configured environment (class path, configuration, native libraries etc.).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.LaunchParams.html" title="class in org.apache.beam.runners.apex">ApexYarnLauncher.LaunchParams</a></td> +<td class="colLast"> +<div class="block">Launch parameters that will be serialized and passed to the child process.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.ProcessWatcher.html" title="class in org.apache.beam.runners.apex">ApexYarnLauncher.ProcessWatcher</a></td> +<td class="colLast"> +<div class="block">Starts a command and waits for it to complete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/beam/runners/apex/TestApexRunner.html" title="class in org.apache.beam.runners.apex">TestApexRunner</a></td> +<td class="colLast"> +<div class="block">Apex <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><code>PipelineRunner</code></a> for testing.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package.description"> +<!-- --> +</a> +<h2 title="Package org.apache.beam.runners.apex Description">Package org.apache.beam.runners.apex Description</h2> +<div class="block">Implementation of the Beam runner for Apache Apex.</div> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Package</li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/apex/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-tree.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-tree.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-tree.html new file mode 100644 index 0000000..bb05c4f --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/apex/package-tree.html @@ -0,0 +1,169 @@ +<!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:57 PST 2017 --> +<title>org.apache.beam.runners.apex Class Hierarchy</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="org.apache.beam.runners.apex Class Hierarchy"; + } + } + 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</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/apex/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.beam.runners.apex</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexRunnerRegistrar</span></a></li> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.Options.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexRunnerRegistrar.Options</span></a> (implements org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/PipelineOptionsRegistrar.html" title="interface in org.apache.beam.sdk.options">PipelineOptionsRegistrar</a>)</li> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexRunnerRegistrar.Runner.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexRunnerRegistrar.Runner</span></a> (implements org.apache.beam.sdk.runners.<a href="../../../../../org/apache/beam/sdk/runners/PipelineRunnerRegistrar.html" title="interface in org.apache.beam.sdk.runners">PipelineRunnerRegistrar</a>)</li> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexRunnerResult.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexRunnerResult</span></a> (implements org.apache.beam.sdk.<a href="../../../../../org/apache/beam/sdk/PipelineResult.html" title="interface in org.apache.beam.sdk">PipelineResult</a>)</li> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexYarnLauncher</span></a></li> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.LaunchParams.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexYarnLauncher.LaunchParams</span></a> (implements java.io.Serializable)</li> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexYarnLauncher.ProcessWatcher.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexYarnLauncher.ProcessWatcher</span></a> (implements java.lang.Runnable)</li> +<li type="circle">org.apache.beam.sdk.runners.<a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><span class="typeNameLink">PipelineRunner</span></a><ResultT> +<ul> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexRunner.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexRunner</span></a></li> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/TestApexRunner.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">TestApexRunner</span></a></li> +</ul> +</li> +<li type="circle">org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">PTransform</span></a><InputT,OutputT> (implements org.apache.beam.sdk.transforms.display.<a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a>, java.io.Serializable) +<ul> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexRunner.CreateApexPCollectionView.html" title="class in org.apache.beam.runners.apex"><span class="typeNameLink">ApexRunner.CreateApexPCollectionView</span></a><ElemT,ViewT></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.beam.sdk.transforms.display.<a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><span class="typeNameLink">HasDisplayData</span></a> +<ul> +<li type="circle">org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options"><span class="typeNameLink">PipelineOptions</span></a> +<ul> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexPipelineOptions.html" title="interface in org.apache.beam.runners.apex"><span class="typeNameLink">ApexPipelineOptions</span></a> (also extends java.io.Serializable)</li> +</ul> +</li> +</ul> +</li> +<li type="circle">java.io.Serializable +<ul> +<li type="circle">org.apache.beam.runners.apex.<a href="../../../../../org/apache/beam/runners/apex/ApexPipelineOptions.html" title="interface in org.apache.beam.runners.apex"><span class="typeNameLink">ApexPipelineOptions</span></a> (also extends org.apache.beam.sdk.options.<a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.html" title="interface in org.apache.beam.sdk.options">PipelineOptions</a>)</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/apex/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html new file mode 100644 index 0000000..7d37036 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html @@ -0,0 +1,338 @@ +<!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:53 PST 2017 --> +<title>BatchStatefulParDoOverrides.BatchStatefulDoFn</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="BatchStatefulParDoOverrides.BatchStatefulDoFn"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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/dataflow/BatchStatefulParDoOverrides.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" target="_top">Frames</a></li> +<li><a href="BatchStatefulParDoOverrides.BatchStatefulDoFn.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.classes.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">Nested</a> | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">Field</a> | </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.dataflow</div> +<h2 title="Class BatchStatefulParDoOverrides.BatchStatefulDoFn" class="title">Class BatchStatefulParDoOverrides.BatchStatefulDoFn<K,V,OutputT></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/DoFn.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.DoFn</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>,<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>>>>>,OutputT></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.BatchStatefulParDoOverrides.BatchStatefulDoFn<K,V,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> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html" title="class in org.apache.beam.runners.dataflow">BatchStatefulParDoOverrides</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">BatchStatefulParDoOverrides.BatchStatefulDoFn<K,V,OutputT></span> +extends <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>,<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,V>>>>>,OutputT></pre> +<div class="block">A key-preserving <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> that explodes an iterable that has been grouped by key and + window.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.dataflow.BatchStatefulParDoOverrides.BatchStatefulDoFn">Serialized Form</a></dd> +</dl> +</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.transforms.DoFn"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.BoundedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.BoundedPerElement</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Context.html" title="class in org.apache.beam.sdk.transforms">DoFn.Context</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.FinishBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.FinishBundle</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetInitialRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetInitialRestriction</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.GetRestrictionCoder.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.GetRestrictionCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.NewTracker.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.NewTracker</a>, <a href="../../../../../org/apache/bea m/sdk/transforms/DoFn.OnTimer.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.OnTimer</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OnTimerContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.OnTimerContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="interface in org.apache.beam.sdk.transforms">DoFn.OutputReceiver</a><<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.OutputReceiver.html" title="type parameter in DoFn.OutputReceiver">T</a>>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContinuation.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContinuation</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sd k.transforms">DoFn.ProcessElement</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Setup.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Setup</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.SplitRestriction.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.SplitRestriction</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StartBundle.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StartBundle</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.StateId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.StateId</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Teardown.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.Teardown</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.TimerId.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.TimerId</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.Unbo undedPerElement.html" title="annotation in org.apache.beam.sdk.transforms">DoFn.UnboundedPerElement</a></code></li> +</ul> +</li> +</ul> +<!-- =========== 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.DoFn"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#aggregators">aggregators</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/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">OutputT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html#getOutputTypeDescriptor--">getOutputTypeDescriptor</a></span>()</code> +<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> capturing what is known statically + about the output type of this <code>DoFn</code> instance's + most-derived class.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">K</a>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">V</a>>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">OutputT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html#getUnderlyingDoFn--">getUnderlyingDoFn</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html#processElement-org.apache.beam.sdk.transforms.DoFn.ProcessContext-org.apache.beam.sdk.transforms.windowing.BoundedWindow-">processElement</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a> c, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.DoFn"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a></h3> +<code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">createAggregator</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">createAggregator</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getAllowedTimestampSkew--">getAllowedTimestampSkew</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getInputTypeDescriptor--">getInputTypeDescriptor</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#prepareForProcessing--">prepareForProcessing</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, 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="getUnderlyingDoFn--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnderlyingDoFn</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">K</a>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">V</a>>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">OutputT</a>> getUnderlyingDoFn()</pre> +</li> +</ul> +<a name="processElement-org.apache.beam.sdk.transforms.DoFn.ProcessContext-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processElement</h4> +<pre><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessElement.html" title="annotation in org.apache.beam.sdk.transforms">@DoFn.ProcessElement</a> +public void processElement(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.ProcessContext.html" title="class in org.apache.beam.sdk.transforms">DoFn.ProcessContext</a> c, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window)</pre> +</li> +</ul> +<a name="getOutputTypeDescriptor--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getOutputTypeDescriptor</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">OutputT</a>> getOutputTypeDescriptor()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getOutputTypeDescriptor--">DoFn</a></code></span></div> +<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values"><code>TypeDescriptor</code></a> capturing what is known statically + about the output type of this <code>DoFn</code> instance's + most-derived class. + + <p>In the normal case of a concrete <code>DoFn</code> subclass with + no generic type parameters of its own (including anonymous inner + classes), this will be a complete non-generic type, which is good + for choosing a default output <code>Coder<O></code> for the output + <code>PCollection<O></code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html#getOutputTypeDescriptor--">getOutputTypeDescriptor</a></code> in class <code><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">K</a>,java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="http://www.joda.org/joda-time/apidocs/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>,<a href="../../../../../org/apache/beam/sdk/util/WindowedValue.html" title="class in org.apache.beam.sdk.util">WindowedValue </a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">K</a>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">V</a>>>>>>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">OutputT</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/dataflow/BatchStatefulParDoOverrides.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" target="_top">Frames</a></li> +<li><a href="BatchStatefulParDoOverrides.BatchStatefulDoFn.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.classes.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">Nested</a> | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.DoFn">Field</a> | </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/dataflow/BatchStatefulParDoOverrides.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html new file mode 100644 index 0000000..8fce805 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html @@ -0,0 +1,320 @@ +<!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:53 PST 2017 --> +<title>BatchStatefulParDoOverrides</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="BatchStatefulParDoOverrides"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev Class</li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html" target="_top">Frames</a></li> +<li><a href="BatchStatefulParDoOverrides.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><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.dataflow</div> +<h2 title="Class BatchStatefulParDoOverrides" class="title">Class BatchStatefulParDoOverrides</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.BatchStatefulParDoOverrides</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BatchStatefulParDoOverrides</span> +extends java.lang.Object</pre> +<div class="block"><a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners"><code>PTransformOverrideFactories</code></a> that expands to correctly implement + stateful <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> using window-unaware <code>BatchViewOverrides.GroupByKeyAndSortValuesOnly</code> to linearize + processing per key. + + <p>This implementation relies on implementation details of the Dataflow runner, specifically + standard fusion behavior of <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> tranforms following a <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</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/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="class in org.apache.beam.runners.dataflow">BatchStatefulParDoOverrides.BatchStatefulDoFn</a><<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">K</a>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">V</a>,<a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="type parameter in BatchStatefulParDoOverrides.BatchStatefulDoFn">OutputT</a>></span></code> +<div class="block">A key-preserving <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> that explodes an iterable that has been grouped by key and + window.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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/dataflow/BatchStatefulParDoOverrides.html#BatchStatefulParDoOverrides--">BatchStatefulParDoOverrides</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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 <K,InputT,OutputT><br><a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners">PTransformOverrideFactory</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>>,<a href="../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values">PCollectionTuple</a>,<a href="../../../../../org/apache/beam/sdk/transforms/ParDo.BoundMulti.html" title="class in org.apache.beam.sdk.transforms">ParDo.BoundMulti</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>,OutputT>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html#multiOutputOverrideFactory--">multiOutputOverrideFactory</a></span>()</code> +<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners"><code>PTransformOverrideFactory</code></a> that replaces a multi-output + <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> with a composite transform specialized for the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <K,InputT,OutputT><br><a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners">PTransformOverrideFactory</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><OutputT>,<a href="../../../../../org/apache/beam/sdk/transforms/ParDo.Bound.html" title="class in org.apache.beam.sdk.transforms">ParDo.Bound</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>,OutputT>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html#singleOutputOverrideFactory--">singleOutputOverrideFactory</a></span>()</code> +<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners"><code>PTransformOverrideFactory</code></a> that replaces a single-output + <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> with a composite transform specialized for the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>.</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BatchStatefulParDoOverrides--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BatchStatefulParDoOverrides</h4> +<pre>public BatchStatefulParDoOverrides()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="singleOutputOverrideFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>singleOutputOverrideFactory</h4> +<pre>public static <K,InputT,OutputT> <a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners">PTransformOverrideFactory</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><OutputT>,<a href="../../../../../org/apache/beam/sdk/transforms/ParDo.Bound.html" title="class in org.apache.beam.sdk.transforms">ParDo.Bound</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>,OutputT>> singleOutputOverrideFactory()</pre> +<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners"><code>PTransformOverrideFactory</code></a> that replaces a single-output + <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> with a composite transform specialized for the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>.</div> +</li> +</ul> +<a name="multiOutputOverrideFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>multiOutputOverrideFactory</h4> +<pre>public static <K,InputT,OutputT> <a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners">PTransformOverrideFactory</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>>,<a href="../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values">PCollectionTuple</a>,<a href="../../../../../org/apache/beam/sdk/transforms/ParDo.BoundMulti.html" title="class in org.apache.beam.sdk.transforms">ParDo.BoundMulti</a><<a href="../../../../../org/apache/beam/sdk/values/KV.html" title="class in org.apache.beam.sdk.values">KV</a><K,InputT>,OutputT>> multiOutputOverrideFactory()</pre> +<div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/runners/PTransformOverrideFactory.html" title="interface in org.apache.beam.sdk.runners"><code>PTransformOverrideFactory</code></a> that replaces a multi-output + <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> with a composite transform specialized for the <a href="../../../../../org/apache/beam/runners/dataflow/DataflowRunner.html" title="class in org.apache.beam.runners.dataflow"><code>DataflowRunner</code></a>.</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>Prev Class</li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/BatchStatefulParDoOverrides.html" target="_top">Frames</a></li> +<li><a href="BatchStatefulParDoOverrides.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><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> http://git-wip-us.apache.org/repos/asf/beam-site/blob/dc04d667/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowClient.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowClient.html b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowClient.html new file mode 100644 index 0000000..4a7f123 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.6.0/org/apache/beam/runners/dataflow/DataflowClient.html @@ -0,0 +1,426 @@ +<!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:53 PST 2017 --> +<title>DataflowClient</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="DataflowClient"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobAlreadyExistsException.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowClient.html" target="_top">Frames</a></li> +<li><a href="DataflowClient.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.dataflow</div> +<h2 title="Class DataflowClient" class="title">Class DataflowClient</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.dataflow.DataflowClient</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">DataflowClient</span> +extends java.lang.Object</pre> +<div class="block">Wrapper around the generated <code>Dataflow</code> client to provide common functionality.</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="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/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow">DataflowClient</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#create-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-">create</a></span>(<a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> options)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.Job</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#createJob-com.google.api.services.dataflow.model.Job-">createJob</a></span>(com.google.api.services.dataflow.model.Job job)</code> +<div class="block">Creates the Dataflow <code>Job</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.Job</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#getJob-java.lang.String-">getJob</a></span>(java.lang.String jobId)</code> +<div class="block">Gets the Dataflow <code>Job</code> with the given <code>jobId</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.JobMetrics</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#getJobMetrics-java.lang.String-">getJobMetrics</a></span>(java.lang.String jobId)</code> +<div class="block">Gets the <code>JobMetrics</code> with the given <code>jobId</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.LeaseWorkItemResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#leaseWorkItem-java.lang.String-com.google.api.services.dataflow.model.LeaseWorkItemRequest-">leaseWorkItem</a></span>(java.lang.String jobId, + com.google.api.services.dataflow.model.LeaseWorkItemRequest request)</code> +<div class="block">Leases the work item for <code>jobId</code>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.ListJobMessagesResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#listJobMessages-java.lang.String-java.lang.String-">listJobMessages</a></span>(java.lang.String jobId, + java.lang.String pageToken)</code> +<div class="block">Lists job messages with the given <code>jobId</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.ListJobsResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#listJobs-java.lang.String-">listJobs</a></span>(java.lang.String pageToken)</code> +<div class="block">Lists Dataflow <code>Jobs</code> in the project associated with + the <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><code>DataflowPipelineOptions</code></a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.ReportWorkItemStatusResponse</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#reportWorkItemStatus-java.lang.String-com.google.api.services.dataflow.model.ReportWorkItemStatusRequest-">reportWorkItemStatus</a></span>(java.lang.String jobId, + com.google.api.services.dataflow.model.ReportWorkItemStatusRequest request)</code> +<div class="block">Reports the status of the work item for <code>jobId</code>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>com.google.api.services.dataflow.model.Job</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html#updateJob-java.lang.String-com.google.api.services.dataflow.model.Job-">updateJob</a></span>(java.lang.String jobId, + com.google.api.services.dataflow.model.Job content)</code> +<div class="block">Updates the Dataflow <code>Job</code> with the given <code>jobId</code>.</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="create-org.apache.beam.runners.dataflow.options.DataflowPipelineOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/beam/runners/dataflow/DataflowClient.html" title="class in org.apache.beam.runners.dataflow">DataflowClient</a> create(<a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options">DataflowPipelineOptions</a> options)</pre> +</li> +</ul> +<a name="createJob-com.google.api.services.dataflow.model.Job-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createJob</h4> +<pre>public com.google.api.services.dataflow.model.Job createJob(@Nonnull + com.google.api.services.dataflow.model.Job job) + throws java.io.IOException</pre> +<div class="block">Creates the Dataflow <code>Job</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="listJobs-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listJobs</h4> +<pre>public com.google.api.services.dataflow.model.ListJobsResponse listJobs(@Nullable + java.lang.String pageToken) + throws java.io.IOException</pre> +<div class="block">Lists Dataflow <code>Jobs</code> in the project associated with + the <a href="../../../../../org/apache/beam/runners/dataflow/options/DataflowPipelineOptions.html" title="interface in org.apache.beam.runners.dataflow.options"><code>DataflowPipelineOptions</code></a>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="updateJob-java.lang.String-com.google.api.services.dataflow.model.Job-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateJob</h4> +<pre>public com.google.api.services.dataflow.model.Job updateJob(@Nonnull + java.lang.String jobId, + @Nonnull + com.google.api.services.dataflow.model.Job content) + throws java.io.IOException</pre> +<div class="block">Updates the Dataflow <code>Job</code> with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="getJob-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJob</h4> +<pre>public com.google.api.services.dataflow.model.Job getJob(@Nonnull + java.lang.String jobId) + throws java.io.IOException</pre> +<div class="block">Gets the Dataflow <code>Job</code> with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="getJobMetrics-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobMetrics</h4> +<pre>public com.google.api.services.dataflow.model.JobMetrics getJobMetrics(@Nonnull + java.lang.String jobId) + throws java.io.IOException</pre> +<div class="block">Gets the <code>JobMetrics</code> with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="listJobMessages-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listJobMessages</h4> +<pre>public com.google.api.services.dataflow.model.ListJobMessagesResponse listJobMessages(@Nonnull + java.lang.String jobId, + @Nullable + java.lang.String pageToken) + throws java.io.IOException</pre> +<div class="block">Lists job messages with the given <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="leaseWorkItem-java.lang.String-com.google.api.services.dataflow.model.LeaseWorkItemRequest-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>leaseWorkItem</h4> +<pre>public com.google.api.services.dataflow.model.LeaseWorkItemResponse leaseWorkItem(@Nonnull + java.lang.String jobId, + @Nonnull + com.google.api.services.dataflow.model.LeaseWorkItemRequest request) + throws java.io.IOException</pre> +<div class="block">Leases the work item for <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="reportWorkItemStatus-java.lang.String-com.google.api.services.dataflow.model.ReportWorkItemStatusRequest-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>reportWorkItemStatus</h4> +<pre>public com.google.api.services.dataflow.model.ReportWorkItemStatusResponse reportWorkItemStatus(@Nonnull + java.lang.String jobId, + @Nonnull + com.google.api.services.dataflow.model.ReportWorkItemStatusRequest request) + throws java.io.IOException</pre> +<div class="block">Reports the status of the work item for <code>jobId</code>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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/dataflow/BatchStatefulParDoOverrides.BatchStatefulDoFn.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/dataflow/DataflowJobAlreadyExistsException.html" title="class in org.apache.beam.runners.dataflow"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/dataflow/DataflowClient.html" target="_top">Frames</a></li> +<li><a href="DataflowClient.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>