blob: 4a58bc34dc90250bdc28cfaf478ce09768cf023d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Wed Aug 14 17:37:12 PDT 2019 -->
<title>Combine.AccumulatingCombineFn (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Combine.AccumulatingCombineFn (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/sdk/transforms/Combine.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" target="_top">Frames</a></li>
<li><a href="Combine.AccumulatingCombineFn.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.sdk.transforms</div>
<h2 title="Class Combine.AccumulatingCombineFn" class="title">Class Combine.AccumulatingCombineFn&lt;InputT,AccumT extends <a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms">Combine.AccumulatingCombineFn.Accumulator</a>&lt;InputT,AccumT,OutputT&gt;,OutputT&gt;</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/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.Combine.CombineFn</a>&lt;InputT,AccumT,OutputT&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.transforms.Combine.AccumulatingCombineFn&lt;InputT,AccumT,OutputT&gt;</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>InputT</code> - type of input values</dd>
<dd><code>AccumT</code> - type of mutable accumulator values</dd>
<dd><code>OutputT</code> - type of output values</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="interface in org.apache.beam.sdk.transforms">CombineFnBase.GlobalCombineFn</a>&lt;InputT,AccumT,OutputT&gt;, <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>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/transforms/ApproximateQuantiles.ApproximateQuantilesCombineFn.html" title="class in org.apache.beam.sdk.transforms">ApproximateQuantiles.ApproximateQuantilesCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Top.TopCombineFn.html" title="class in org.apache.beam.sdk.transforms">Top.TopCombineFn</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/transforms/Combine.html" title="class in org.apache.beam.sdk.transforms">Combine</a></dd>
</dl>
<hr>
<br>
<pre>public abstract static class <span class="typeNameLabel">Combine.AccumulatingCombineFn&lt;InputT,AccumT extends <a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms">Combine.AccumulatingCombineFn.Accumulator</a>&lt;InputT,AccumT,OutputT&gt;,OutputT&gt;</span>
extends <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&lt;InputT,AccumT,OutputT&gt;</pre>
<div class="block">A <code>CombineFn</code> that uses a subclass of <a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms"><code>Combine.AccumulatingCombineFn.Accumulator</code></a> as its
accumulator type. By defining the operations of the <code>Accumulator</code> helper class, the
operations of the enclosing <code>CombineFn</code> are automatically provided. This can reduce the
code required to implement a <code>CombineFn</code>.
<p>For example, the example from <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> above can be expressed using <code>AccumulatingCombineFn</code> more concisely as follows:
<pre><code>
public class AverageFn
extends AccumulatingCombineFn&lt;Integer, AverageFn.Accum, Double&gt; {
public Accum createAccumulator() {
return new Accum();
}
public class Accum
extends AccumulatingCombineFn&lt;Integer, AverageFn.Accum, Double&gt;
.Accumulator {
private int sum = 0;
private int count = 0;
public void addInput(Integer input) {
sum += input;
count++;
}
public void mergeAccumulator(Accum other) {
sum += other.sum;
count += other.count;
}
public Double extractOutput() {
return ((double) sum) / count;
}
}
}
PCollection&lt;Integer&gt; pc = ...;
PCollection&lt;Double&gt; average = pc.apply(Combine.globally(new AverageFn()));
</code></pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.beam.sdk.transforms.Combine.AccumulatingCombineFn">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>
<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">&nbsp;</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 interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms">Combine.AccumulatingCombineFn.Accumulator</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="type parameter in Combine.AccumulatingCombineFn.Accumulator">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="type parameter in Combine.AccumulatingCombineFn.Accumulator">AccumT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="type parameter in Combine.AccumulatingCombineFn.Accumulator">OutputT</a>&gt;</span></code>
<div class="block">The type of mutable accumulator values used by this <code>AccumulatingCombineFn</code>.</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">&nbsp;</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/sdk/transforms/Combine.AccumulatingCombineFn.html#AccumulatingCombineFn--">AccumulatingCombineFn</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#addInput-AccumT-InputT-">addInput</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&nbsp;accumulator,
<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>&nbsp;input)</code>
<div class="block">Adds the given input value to the given accumulator, returning the new accumulator value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#extractOutput-AccumT-">extractOutput</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&nbsp;accumulator)</code>
<div class="block">Returns the output value that is the result of combining all the input values represented by
the given accumulator.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.reflect.TypeVariable&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#getAccumTVariable--">getAccumTVariable</a></span>()</code>
<div class="block">Returns the <code>TypeVariable</code> of <code>AccumT</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;AccumT&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#getAccumulatorCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">getAccumulatorCoder</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a>&nbsp;registry,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;InputT&gt;&nbsp;inputCoder)</code>
<div class="block">Returns the <code>Coder</code> to use for accumulator <code>AccumT</code> values, or null if it is not
able to be inferred.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;OutputT&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#getDefaultOutputCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">getDefaultOutputCoder</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a>&nbsp;registry,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;InputT&gt;&nbsp;inputCoder)</code>
<div class="block">Returns the <code>Coder</code> to use by default for output <code>OutputT</code> values, or null if it
is not able to be inferred.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#getIncompatibleGlobalWindowErrorMessage--">getIncompatibleGlobalWindowErrorMessage</a></span>()</code>
<div class="block">Returns the error message for not supported default values in Combine.globally().</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.reflect.TypeVariable&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#getInputTVariable--">getInputTVariable</a></span>()</code>
<div class="block">Returns the <code>TypeVariable</code> of <code>InputT</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.reflect.TypeVariable&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#getOutputTVariable--">getOutputTVariable</a></span>()</code>
<div class="block">Returns the <code>TypeVariable</code> of <code>OutputT</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#mergeAccumulators-java.lang.Iterable-">mergeAccumulators</a></span>(java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&gt;&nbsp;accumulators)</code>
<div class="block">Returns an accumulator representing the accumulation of all the input values accumulated in
the merging accumulators.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</code>
<div class="block">Register display data for the given transform or component.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.Combine.CombineFn">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.transforms.<a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#apply-java.lang.Iterable-">apply</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#compact-AccumT-">compact</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#createAccumulator--">createAccumulator</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#defaultValue--">defaultValue</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#getInputType--">getInputType</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#getOutputType--">getOutputType</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&nbsp;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="AccumulatingCombineFn--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AccumulatingCombineFn</h4>
<pre>public&nbsp;AccumulatingCombineFn()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addInput-org.apache.beam.sdk.transforms.Combine.AccumulatingCombineFn.Accumulator-java.lang.Object-">
<!-- -->
</a><a name="addInput-AccumT-InputT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInput</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&nbsp;addInput(<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&nbsp;accumulator,
<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>&nbsp;input)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#addInput-AccumT-InputT-">Combine.CombineFn</a></code></span></div>
<div class="block">Adds the given input value to the given accumulator, returning the new accumulator value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#addInput-AccumT-InputT-">addInput</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms">Combine.AccumulatingCombineFn.Accumulator</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a>&gt;,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accumulator</code> - may be modified and returned for efficiency</dd>
<dd><code>input</code> - should not be mutated</dd>
</dl>
</li>
</ul>
<a name="mergeAccumulators-java.lang.Iterable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeAccumulators</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&nbsp;mergeAccumulators(java.lang.Iterable&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&gt;&nbsp;accumulators)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#mergeAccumulators-java.lang.Iterable-">Combine.CombineFn</a></code></span></div>
<div class="block">Returns an accumulator representing the accumulation of all the input values accumulated in
the merging accumulators.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#mergeAccumulators-java.lang.Iterable-">mergeAccumulators</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms">Combine.AccumulatingCombineFn.Accumulator</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a>&gt;,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accumulators</code> - only the first accumulator may be modified and returned for efficiency;
the other accumulators should not be mutated, because they may be shared with other code
and mutating them could lead to incorrect results or data corruption.</dd>
</dl>
</li>
</ul>
<a name="extractOutput-org.apache.beam.sdk.transforms.Combine.AccumulatingCombineFn.Accumulator-">
<!-- -->
</a><a name="extractOutput-AccumT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractOutput</h4>
<pre>public final&nbsp;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a>&nbsp;extractOutput(<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>&nbsp;accumulator)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#extractOutput-AccumT-">Combine.CombineFn</a></code></span></div>
<div class="block">Returns the output value that is the result of combining all the input values represented by
the given accumulator.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html#extractOutput-AccumT-">extractOutput</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms">Combine.AccumulatingCombineFn.Accumulator</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">InputT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">AccumT</a>,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a>&gt;,<a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="type parameter in Combine.AccumulatingCombineFn">OutputT</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accumulator</code> - can be modified for efficiency</dd>
</dl>
</li>
</ul>
<a name="getAccumulatorCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAccumulatorCoder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;AccumT&gt;&nbsp;getAccumulatorCoder(<a href="../../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a>&nbsp;registry,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;InputT&gt;&nbsp;inputCoder)
throws <a href="../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html#getAccumulatorCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">CombineFnBase.GlobalCombineFn</a></code></span></div>
<div class="block">Returns the <code>Coder</code> to use for accumulator <code>AccumT</code> values, or null if it is not
able to be inferred.
<p>By default, uses the knowledge of the <code>Coder</code> being used for <code>InputT</code> values
and the enclosing <code>Pipeline</code>'s <code>CoderRegistry</code> to try to infer the Coder for
<code>AccumT</code> values.
<p>This is the Coder used to send data through a communication-intensive shuffle step, so a
compact and efficient representation may have significant performance benefits.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html#getAccumulatorCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">getAccumulatorCoder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="interface in org.apache.beam.sdk.transforms">CombineFnBase.GlobalCombineFn</a>&lt;InputT,AccumT,OutputT&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></code></dd>
</dl>
</li>
</ul>
<a name="getDefaultOutputCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultOutputCoder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;OutputT&gt;&nbsp;getDefaultOutputCoder(<a href="../../../../../org/apache/beam/sdk/coders/CoderRegistry.html" title="class in org.apache.beam.sdk.coders">CoderRegistry</a>&nbsp;registry,
<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;InputT&gt;&nbsp;inputCoder)
throws <a href="../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html#getDefaultOutputCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">CombineFnBase.GlobalCombineFn</a></code></span></div>
<div class="block">Returns the <code>Coder</code> to use by default for output <code>OutputT</code> values, or null if it
is not able to be inferred.
<p>By default, uses the knowledge of the <code>Coder</code> being used for input <code>InputT</code>
values and the enclosing <code>Pipeline</code>'s <code>CoderRegistry</code> to try to infer the Coder
for <code>OutputT</code> values.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html#getDefaultOutputCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">getDefaultOutputCoder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="interface in org.apache.beam.sdk.transforms">CombineFnBase.GlobalCombineFn</a>&lt;InputT,AccumT,OutputT&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/coders/CannotProvideCoderException.html" title="class in org.apache.beam.sdk.coders">CannotProvideCoderException</a></code></dd>
</dl>
</li>
</ul>
<a name="getIncompatibleGlobalWindowErrorMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIncompatibleGlobalWindowErrorMessage</h4>
<pre>public&nbsp;java.lang.String&nbsp;getIncompatibleGlobalWindowErrorMessage()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html#getIncompatibleGlobalWindowErrorMessage--">CombineFnBase.GlobalCombineFn</a></code></span></div>
<div class="block">Returns the error message for not supported default values in Combine.globally().</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html#getIncompatibleGlobalWindowErrorMessage--">getIncompatibleGlobalWindowErrorMessage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="interface in org.apache.beam.sdk.transforms">CombineFnBase.GlobalCombineFn</a>&lt;InputT,AccumT,OutputT&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getInputTVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputTVariable</h4>
<pre>public&nbsp;java.lang.reflect.TypeVariable&lt;?&gt;&nbsp;getInputTVariable()</pre>
<div class="block">Returns the <code>TypeVariable</code> of <code>InputT</code>.</div>
</li>
</ul>
<a name="getAccumTVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAccumTVariable</h4>
<pre>public&nbsp;java.lang.reflect.TypeVariable&lt;?&gt;&nbsp;getAccumTVariable()</pre>
<div class="block">Returns the <code>TypeVariable</code> of <code>AccumT</code>.</div>
</li>
</ul>
<a name="getOutputTVariable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputTVariable</h4>
<pre>public&nbsp;java.lang.reflect.TypeVariable&lt;?&gt;&nbsp;getOutputTVariable()</pre>
<div class="block">Returns the <code>TypeVariable</code> of <code>OutputT</code>.</div>
</li>
</ul>
<a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>populateDisplayData</h4>
<pre>public&nbsp;void&nbsp;populateDisplayData(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</pre>
<div class="block">Register display data for the given transform or component.
<p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect
display data via <a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call <code>super.populateDisplayData(builder)</code> in order to register display data in the current namespace,
but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use the namespace
of the subcomponent.
<p>By default, does not register any display data. Implementors may override this method to
provide their own display data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - The builder to populate with display data.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/transforms/Combine.html" title="class in org.apache.beam.sdk.transforms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.Accumulator.html" title="interface in org.apache.beam.sdk.transforms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" target="_top">Frames</a></li>
<li><a href="Combine.AccumulatingCombineFn.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>