blob: c3cd82c1049b1ae7f70d73b5203f8af51857e397 [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 -->
<title>HllCount.MergePartial (Apache Beam 2.38.0-SNAPSHOT)</title>
<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="HllCount.MergePartial (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/zetasketch/HllCount.MergePartial.html" target="_top">Frames</a></li>
<li><a href="HllCount.MergePartial.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.extensions.zetasketch</div>
<h2 title="Class HllCount.MergePartial" class="title">Class HllCount.MergePartial</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.zetasketch.HllCount.MergePartial</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.html" title="class in org.apache.beam.sdk.extensions.zetasketch">HllCount</a></dd>
</dl>
<hr>
<br>
<pre>public static final class <span class="typeNameLabel">HllCount.MergePartial</span>
extends java.lang.Object</pre>
<div class="block">Provides <code>PTransform</code>s to merge HLL++ sketches into a new sketch.
<p>Only sketches of the same type can be merged together. If incompatible sketches are
provided, a runtime error will occur.
<p>If sketches of different <code>precision</code>s are merged, the merged sketch will get the
minimum precision encountered among all the input sketches.
<p>An "empty sketch" represented by an byte array of length 0 is returned if the input <code>PCollection</code> is empty.
<p>Corresponds to the <code>HLL_COUNT.MERGE_PARTIAL(sketch)</code> function in <a
href="https://cloud.google.com/bigquery/docs/reference/standard-sql/hll_functions">BigQuery</a>.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../../../../org/apache/beam/sdk/transforms/Combine.Globally.html" title="class in org.apache.beam.sdk.transforms">Combine.Globally</a>&lt;byte[],byte[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.MergePartial.html#globally--">globally</a></span>()</code>
<div class="block">Returns a <code>Combine.Globally</code> <code>PTransform</code> that takes an input <code>PCollection&lt;byte[]&gt;</code> of HLL++ sketches and returns a <code>PCollection&lt;byte[]&gt;</code> of a new
sketch merged from the input sketches.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;K&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/Combine.PerKey.html" title="class in org.apache.beam.sdk.transforms">Combine.PerKey</a>&lt;K,byte[],byte[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.MergePartial.html#perKey--">perKey</a></span>()</code>
<div class="block">Returns a <code>Combine.PerKey</code> <code>PTransform</code> that takes an input <code>PCollection&lt;KV&lt;K, byte[]&gt;&gt;</code> of (key, HLL++ sketch) pairs and returns a <code>PCollection&lt;KV&lt;K, byte[]&gt;&gt;</code> of (key, new sketch merged from the input sketches under the
key).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="globally--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>globally</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/Combine.Globally.html" title="class in org.apache.beam.sdk.transforms">Combine.Globally</a>&lt;byte[],byte[]&gt;&nbsp;globally()</pre>
<div class="block">Returns a <code>Combine.Globally</code> <code>PTransform</code> that takes an input <code>PCollection&lt;byte[]&gt;</code> of HLL++ sketches and returns a <code>PCollection&lt;byte[]&gt;</code> of a new
sketch merged from the input sketches.
<p>Only sketches of the same type can be merged together. If incompatible sketches are
provided, a runtime error will occur.
<p>If sketches of different <code>precision</code>s are merged, the merged sketch will get the
minimum precision encountered among all the input sketches.
<p>Returns a singleton <code>PCollection</code> with an "empty sketch" (byte array of length 0) if
the input <code>PCollection</code> is empty.</div>
</li>
</ul>
<a name="perKey--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>perKey</h4>
<pre>public static&nbsp;&lt;K&gt;&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/Combine.PerKey.html" title="class in org.apache.beam.sdk.transforms">Combine.PerKey</a>&lt;K,byte[],byte[]&gt;&nbsp;perKey()</pre>
<div class="block">Returns a <code>Combine.PerKey</code> <code>PTransform</code> that takes an input <code>PCollection&lt;KV&lt;K, byte[]&gt;&gt;</code> of (key, HLL++ sketch) pairs and returns a <code>PCollection&lt;KV&lt;K, byte[]&gt;&gt;</code> of (key, new sketch merged from the input sketches under the
key).
<p>If sketches of different <code>precision</code>s are merged, the merged sketch will get the
minimum precision encountered among all the input sketches.
<p>Only sketches of the same type can be merged together. If incompatible sketches are
provided, a runtime error will occur.</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/extensions/zetasketch/HllCount.Init.Builder.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/zetasketch/HllCount.MergePartial.html" target="_top">Frames</a></li>
<li><a href="HllCount.MergePartial.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>