http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SplittableParDo.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SplittableParDo.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SplittableParDo.html new file mode 100644 index 0000000..3b7e8db --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SplittableParDo.html @@ -0,0 +1,345 @@ +<!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_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SplittableParDo (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<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="SplittableParDo (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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="class-use/SplittableParDo.html">Use</a></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/core/SimpleDoFnRunner.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SplittableParDo.html" target="_top">Frames</a></li> +<li><a href="SplittableParDo.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.core</div> +<h2 title="Class SplittableParDo" class="title">Class SplittableParDo<InputT,OutputT,RestrictionT,TrackerT extends <a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><RestrictionT>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></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><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><InputT>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><OutputT>></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.SplittableParDo<InputT,OutputT,RestrictionT,TrackerT></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <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><a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SPLITTABLE_DO_FN">SPLITTABLE_DO_FN</a>) +public class <span class="typeNameLabel">SplittableParDo<InputT,OutputT,RestrictionT,TrackerT extends <a href="../../../../../org/apache/beam/sdk/transforms/splittabledofn/RestrictionTracker.html" title="interface in org.apache.beam.sdk.transforms.splittabledofn">RestrictionTracker</a><RestrictionT>></span> +extends <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><InputT>,<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><OutputT>></pre> +<div class="block">A utility transform that executes a <a + href="https://s.apache.org/splittable-do-fn">splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> by expanding it into a + network of simpler transforms: + + <ol> + <li>Pair each element with an initial restriction + <li>Split each restriction into sub-restrictions + <li>Assign a unique key to each element/restriction pair + <li>Group by key (so that work is partitioned by key and we can access state/timers) + <li>Process each keyed element/restriction pair with the splittable <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>'s <code>DoFn.ProcessElement</code> method, using state and timers API. + </ol> + + <p>This transform is intended as a helper for internal use by runners when implementing <code>ParDo.of(splittable DoFn)</code>, but not for direct use by pipeline writers.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.SplittableParDo">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/core/SplittableParDo.html#SplittableParDo-org.apache.beam.sdk.transforms.DoFn-">SplittableParDo</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">OutputT</a>> fn)</code> +<div class="block">Creates the transform for the given original <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</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="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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">OutputT</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html#apply-org.apache.beam.sdk.values.PCollection-">apply</a></span>(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">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> +</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#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.TypedPValue-">getDefaultOutputCoder</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-InputT-">valida te</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="SplittableParDo-org.apache.beam.sdk.transforms.DoFn-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SplittableParDo</h4> +<pre>public SplittableParDo(<a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms">DoFn</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">OutputT</a>> fn)</pre> +<div class="block">Creates the transform for the given original <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fn</code> - The splittable <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> inside the original <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> transform.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="apply-org.apache.beam.sdk.values.PCollection-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>apply</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">OutputT</a>> apply(<a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">InputT</a>> input)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/sdk/transforms/PTransform.html#apply-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#apply-InputT-">apply</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/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../org/apache/beam/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">InputT</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/runners/core/SplittableParDo.html" title="type parameter in SplittableParDo">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="class-use/SplittableParDo.html">Use</a></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/core/SimpleDoFnRunner.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SplittableParDo.html" target="_top">Frames</a></li> +<li><a href="SplittableParDo.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 ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/141627ec/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SystemReduceFn.html ---------------------------------------------------------------------- diff --git a/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SystemReduceFn.html b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SystemReduceFn.html new file mode 100644 index 0000000..bebcb01 --- /dev/null +++ b/content/learn/sdks/javadoc/0.3.0-incubating/org/apache/beam/runners/core/SystemReduceFn.html @@ -0,0 +1,463 @@ +<!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_102) on Mon Oct 31 14:28:39 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SystemReduceFn (Apache Beam SDK for Java, version 0.3.0-incubating)</title> +<meta name="date" content="2016-10-31"> +<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="SystemReduceFn (Apache Beam SDK for Java, version 0.3.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":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="class-use/SystemReduceFn.html">Use</a></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/core/SplittableParDo.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/UnboundedReadFromBoundedSource.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SystemReduceFn.html" target="_top">Frames</a></li> +<li><a href="SystemReduceFn.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.runners.core.ReduceFn">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.core</div> +<h2 title="Class SystemReduceFn" class="title">Class SystemReduceFn<K,InputT,AccumT,OutputT,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">org.apache.beam.runners.core.ReduceFn</a><K,InputT,OutputT,W></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.SystemReduceFn<K,InputT,AccumT,OutputT,W></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - The type of key being processed.</dd> +<dd><code>InputT</code> - The type of values associated with the key.</dd> +<dd><code>OutputT</code> - The output type that will be produced for each key.</dd> +<dd><code>W</code> - The type of windows this operates on.</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">SystemReduceFn<K,InputT,AccumT,OutputT,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></span> +extends <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a><K,InputT,OutputT,W></pre> +<div class="block"><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core"><code>ReduceFn</code></a> implementing the default reduction behaviors of <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.SystemReduceFn">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.runners.core.ReduceFn"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.beam.runners.core.<a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a></h3> +<code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a>, <a href="../../../../../org/apache/beam/runners/core/ReduceFn.OnMergeContext.html" title="class in org.apache.beam.runners.core">ReduceFn.OnMergeContext</a>, <a href="../../../../../org/apache/beam/runners/core/ReduceFn.OnTriggerContext.html" title="class in org.apache.beam.runners.core">ReduceFn.OnTriggerContext</a>, <a href="../../../../../org/apache/beam/runners/core/ReduceFn.ProcessValueContext.html" title="class in org.apache.beam.runners.core">ReduceFn.ProcessValueContext</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/core/SystemReduceFn.html#SystemReduceFn-org.apache.beam.sdk.util.state.StateTag-">SystemReduceFn</a></span>(<a href="../../../../../org/apache/beam/sdk/util/state/StateTag.html" title="interface in org.apache.beam.sdk.util.state">StateTag</a><? super <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>,? extends <a href="../../../../../org/apache/beam/sdk/util/state/CombiningState.html" title="interface in org.apache.beam.sdk.util.state">CombiningState</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">OutputT</a>>> bufferTag)</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="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 <K,T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core">SystemReduceFn</a><K,T,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T>,W></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html#buffering-org.apache.beam.sdk.coders.Coder-">buffering</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T> inputCoder)</code> +<div class="block">Create a factory that produces <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core"><code>SystemReduceFn</code></a> instances that that buffer all of the + input values in persistent state and produces an <code>Iterable<T></code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html#clearState-org.apache.beam.runners.core.ReduceFn.Context-">clearState</a></span>(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> c)</code> +<div class="block">Called to clear any persisted state that the <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core"><code>ReduceFn</code></a> may be holding.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <K,InputT,AccumT,OutputT,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core">SystemReduceFn</a><K,InputT,AccumT,OutputT,W></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html#combining-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.util.AppliedCombineFn-">combining</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><K> keyCoder, + <a href="../../../../../org/apache/beam/sdk/util/AppliedCombineFn.html" title="class in org.apache.beam.sdk.util">AppliedCombineFn</a><K,InputT,AccumT,OutputT> combineFn)</code> +<div class="block">Create a factory that produces <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core"><code>SystemReduceFn</code></a> instances that combine all of the input + values using a <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/state/ReadableState.html" title="interface in org.apache.beam.sdk.util.state">ReadableState</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html#isEmpty-org.apache.beam.sdk.util.state.StateAccessor-">isEmpty</a></span>(<a href="../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>> state)</code> +<div class="block">Returns true if the there is no buffered state.</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/core/SystemReduceFn.html#onTrigger-org.apache.beam.runners.core.ReduceFn.OnTriggerContext-">onTrigger</a></span>(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.OnTriggerContext.html" title="class in org.apache.beam.runners.core">ReduceFn.OnTriggerContext</a> c)</code> +<div class="block">Called when triggers fire.</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/core/SystemReduceFn.html#prefetchOnTrigger-org.apache.beam.sdk.util.state.StateAccessor-">prefetchOnTrigger</a></span>(<a href="../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>> state)</code> +<div class="block">Called before <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#onTrigger-org.apache.beam.runners.core.ReduceFn.OnTriggerContext-"><code>ReduceFn.onTrigger(org.apache.beam.runners.core.ReduceFn<K, InputT, OutputT, W>.OnTriggerContext)</code></a> is invoked to provide an opportunity to prefetch any needed + state.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html#processValue-org.apache.beam.runners.core.ReduceFn.ProcessValueContext-">processValue</a></span>(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.ProcessValueContext.html" title="class in org.apache.beam.runners.core">ReduceFn.ProcessValueContext</a> c)</code> +<div class="block">Called for each value of type <code>InputT</code> associated with the current key.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.core.ReduceFn"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.core.<a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a></h3> +<code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#onMerge-org.apache.beam.runners.core.ReduceFn.OnMergeContext-">onMerge</a>, <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#prefetchOnMerge-org.apache.beam.sdk.util.state.MergingStateAccessor-">prefetchOnMerge</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="SystemReduceFn-org.apache.beam.sdk.util.state.StateTag-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SystemReduceFn</h4> +<pre>public SystemReduceFn(<a href="../../../../../org/apache/beam/sdk/util/state/StateTag.html" title="interface in org.apache.beam.sdk.util.state">StateTag</a><? super <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>,? extends <a href="../../../../../org/apache/beam/sdk/util/state/CombiningState.html" title="interface in org.apache.beam.sdk.util.state">CombiningState</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">OutputT</a>>> bufferTag)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="buffering-org.apache.beam.sdk.coders.Coder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buffering</h4> +<pre>public static <K,T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core">SystemReduceFn</a><K,T,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T>,W> buffering(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><T> inputCoder)</pre> +<div class="block">Create a factory that produces <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core"><code>SystemReduceFn</code></a> instances that that buffer all of the + input values in persistent state and produces an <code>Iterable<T></code>.</div> +</li> +</ul> +<a name="combining-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.util.AppliedCombineFn-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>combining</h4> +<pre>public static <K,InputT,AccumT,OutputT,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core">SystemReduceFn</a><K,InputT,AccumT,OutputT,W> combining(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders">Coder</a><K> keyCoder, + <a href="../../../../../org/apache/beam/sdk/util/AppliedCombineFn.html" title="class in org.apache.beam.sdk.util">AppliedCombineFn</a><K,InputT,AccumT,OutputT> combineFn)</pre> +<div class="block">Create a factory that produces <a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="class in org.apache.beam.runners.core"><code>SystemReduceFn</code></a> instances that combine all of the input + values using a <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>.</div> +</li> +</ul> +<a name="processValue-org.apache.beam.runners.core.ReduceFn.ProcessValueContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processValue</h4> +<pre>public void processValue(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.ProcessValueContext.html" title="class in org.apache.beam.runners.core">ReduceFn.ProcessValueContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#processValue-org.apache.beam.runners.core.ReduceFn.ProcessValueContext-">ReduceFn</a></code></span></div> +<div class="block">Called for each value of type <code>InputT</code> associated with the current key.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#processValue-org.apache.beam.runners.core.ReduceFn.ProcessValueContext-">processValue</a></code> in class <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">OutputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">W</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>>< /code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="prefetchOnTrigger-org.apache.beam.sdk.util.state.StateAccessor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prefetchOnTrigger</h4> +<pre>public void prefetchOnTrigger(<a href="../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>> state)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#prefetchOnTrigger-org.apache.beam.sdk.util.state.StateAccessor-">ReduceFn</a></code></span></div> +<div class="block">Called before <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#onTrigger-org.apache.beam.runners.core.ReduceFn.OnTriggerContext-"><code>ReduceFn.onTrigger(org.apache.beam.runners.core.ReduceFn<K, InputT, OutputT, W>.OnTriggerContext)</code></a> is invoked to provide an opportunity to prefetch any needed + state.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#prefetchOnTrigger-org.apache.beam.sdk.util.state.StateAccessor-">prefetchOnTrigger</a></code> in class <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">OutputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">W</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></co de></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>state</code> - Context to use prefetch from.</dd> +</dl> +</li> +</ul> +<a name="onTrigger-org.apache.beam.runners.core.ReduceFn.OnTriggerContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onTrigger</h4> +<pre>public void onTrigger(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.OnTriggerContext.html" title="class in org.apache.beam.runners.core">ReduceFn.OnTriggerContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#onTrigger-org.apache.beam.runners.core.ReduceFn.OnTriggerContext-">ReduceFn</a></code></span></div> +<div class="block">Called when triggers fire. + + <p>Implementations of <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core"><code>ReduceFn</code></a> should call <a href="../../../../../org/apache/beam/runners/core/ReduceFn.OnTriggerContext.html#output-OutputT-"><code>ReduceFn.OnTriggerContext.output(OutputT)</code></a> to emit + any results that should be included in the pane produced by this trigger firing.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#onTrigger-org.apache.beam.runners.core.ReduceFn.OnTriggerContext-">onTrigger</a></code> in class <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">OutputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">W</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></code></d d> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="clearState-org.apache.beam.runners.core.ReduceFn.Context-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearState</h4> +<pre>public void clearState(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#clearState-org.apache.beam.runners.core.ReduceFn.Context-">ReduceFn</a></code></span></div> +<div class="block">Called to clear any persisted state that the <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core"><code>ReduceFn</code></a> may be holding. This will be + called when the windowing is closing and will receive no future interactions.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#clearState-org.apache.beam.runners.core.ReduceFn.Context-">clearState</a></code> in class <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">OutputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">W</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="isEmpty-org.apache.beam.sdk.util.state.StateAccessor-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/util/state/ReadableState.html" title="interface in org.apache.beam.sdk.util.state">ReadableState</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>> isEmpty(<a href="../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>> state)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#isEmpty-org.apache.beam.sdk.util.state.StateAccessor-">ReduceFn</a></code></span></div> +<div class="block">Returns true if the there is no buffered state.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#isEmpty-org.apache.beam.sdk.util.state.StateAccessor-">isEmpty</a></code> in class <code><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core">ReduceFn</a><<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">K</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">InputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">OutputT</a>,<a href="../../../../../org/apache/beam/runners/core/SystemReduceFn.html" title="type parameter in SystemReduceFn">W</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</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="class-use/SystemReduceFn.html">Use</a></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/core/SplittableParDo.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/UnboundedReadFromBoundedSource.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/SystemReduceFn.html" target="_top">Frames</a></li> +<li><a href="SystemReduceFn.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.runners.core.ReduceFn">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 ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>