blob: 6e1f14926812a8bf71b1641a666b9e22808ef700 [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:13 PDT 2019 -->
<title>CombineFnBase.GlobalCombineFn (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="CombineFnBase.GlobalCombineFn (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.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/CombineFns.html" title="class 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/CombineFnBase.GlobalCombineFn.html" target="_top">Frames</a></li>
<li><a href="CombineFnBase.GlobalCombineFn.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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="Interface CombineFnBase.GlobalCombineFn" class="title">Interface CombineFnBase.GlobalCombineFn&lt;InputT,AccumT,OutputT&gt;</h2>
</div>
<div class="contentContainer">
<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 Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a>, java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/extensions/sketching/ApproximateDistinct.ApproximateDistinctFn.html" title="class in org.apache.beam.sdk.extensions.sketching">ApproximateDistinct.ApproximateDistinctFn</a>, <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/ApproximateUnique.ApproximateUniqueCombineFn.html" title="class in org.apache.beam.sdk.transforms">ApproximateUnique.ApproximateUniqueCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.AccumulatingCombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.AccumulatingCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.BinaryCombineDoubleFn.html" title="class in org.apache.beam.sdk.transforms">Combine.BinaryCombineDoubleFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.BinaryCombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.BinaryCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.BinaryCombineIntegerFn.html" title="class in org.apache.beam.sdk.transforms">Combine.BinaryCombineIntegerFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.BinaryCombineLongFn.html" title="class in org.apache.beam.sdk.transforms">Combine.BinaryCombineLongFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.IterableCombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.IterableCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Combine.SimpleCombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.SimpleCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/CombineFns.ComposedCombineFn.html" title="class in org.apache.beam.sdk.transforms">CombineFns.ComposedCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/CombineFns.ComposedCombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms">CombineFns.ComposedCombineFnWithContext</a>, <a href="../../../../../org/apache/beam/sdk/transforms/CombineWithContext.CombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms">CombineWithContext.CombineFnWithContext</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sql/impl/transform/agg/CovarianceFn.html" title="class in org.apache.beam.sdk.extensions.sql.impl.transform.agg">CovarianceFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Sample.FixedSizedSampleFn.html" title="class in org.apache.beam.sdk.transforms">Sample.FixedSizedSampleFn</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sketching/SketchFrequencies.CountMinSketchFn.html" title="class in org.apache.beam.sdk.extensions.sketching">SketchFrequencies.CountMinSketchFn</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sketching/TDigestQuantiles.TDigestQuantilesFn.html" title="class in org.apache.beam.sdk.extensions.sketching">TDigestQuantiles.TDigestQuantilesFn</a>, <a href="../../../../../org/apache/beam/sdk/transforms/Top.TopCombineFn.html" title="class in org.apache.beam.sdk.transforms">Top.TopCombineFn</a>, <a href="../../../../../org/apache/beam/sdk/extensions/sql/impl/transform/agg/VarianceFn.html" title="class in org.apache.beam.sdk.extensions.sql.impl.transform.agg">VarianceFn</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.html" title="class in org.apache.beam.sdk.transforms">CombineFnBase</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
public static interface <span class="typeNameLabel">CombineFnBase.GlobalCombineFn&lt;InputT,AccumT,OutputT&gt;</span>
extends java.io.Serializable, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></pre>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b>
<p>A <code>GloballyCombineFn&lt;InputT, AccumT, OutputT&gt;</code> specifies how to combine a collection
of input values of type <code>InputT</code> into a single output value of type <code>OutputT</code>. It
does this via one or more intermediate mutable accumulator values of type <code>AccumT</code>.
<p>Do not implement this interface directly. Extends <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/CombineWithContext.CombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms"><code>CombineWithContext.CombineFnWithContext</code></a> instead.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">OutputT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html#defaultValue--">defaultValue</a></span>()</code>
<div class="block">Returns the default value when there are no values added to the accumulator.</div>
</td>
</tr>
<tr id="i1" 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;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">AccumT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></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;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">InputT</a>&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="i2" 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;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">OutputT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></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;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">InputT</a>&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="i3" 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/CombineFnBase.GlobalCombineFn.html#getIncompatibleGlobalWindowErrorMessage--">getIncompatibleGlobalWindowErrorMessage</a></span>()</code>
<div class="block">Returns the error message for not supported default values in Combine.globally().</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.display.HasDisplayData">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.beam.sdk.transforms.display.<a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></h3>
<code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAccumulatorCoder-org.apache.beam.sdk.coders.CoderRegistry-org.apache.beam.sdk.coders.Coder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAccumulatorCoder</h4>
<pre><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">AccumT</a>&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;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">InputT</a>&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">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="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><a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">OutputT</a>&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;<a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">InputT</a>&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">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="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>java.lang.String&nbsp;getIncompatibleGlobalWindowErrorMessage()</pre>
<div class="block">Returns the error message for not supported default values in Combine.globally().</div>
</li>
</ul>
<a name="defaultValue--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>defaultValue</h4>
<pre><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.GlobalCombineFn.html" title="type parameter in CombineFnBase.GlobalCombineFn">OutputT</a>&nbsp;defaultValue()</pre>
<div class="block">Returns the default value when there are no values added to the accumulator.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.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/CombineFns.html" title="class 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/CombineFnBase.GlobalCombineFn.html" target="_top">Frames</a></li>
<li><a href="CombineFnBase.GlobalCombineFn.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>