blob: e8d172c84676d44fe649143bcd8327c4e80b5107 [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.Init.Builder (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.Init.Builder (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.MergePartial.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" target="_top">Frames</a></li>
<li><a href="HllCount.Init.Builder.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.Init.Builder" class="title">Class HllCount.Init.Builder&lt;InputT&gt;</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.Init.Builder&lt;InputT&gt;</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> - element type or value type in <code>KV</code>s of the input <code>PCollection</code> to
the <code>PTransform</code> being built</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.html" title="class in org.apache.beam.sdk.extensions.zetasketch">HllCount.Init</a></dd>
</dl>
<hr>
<br>
<pre>public static final class <span class="typeNameLabel">HllCount.Init.Builder&lt;InputT&gt;</span>
extends java.lang.Object</pre>
<div class="block">Builder for the <code>HllCount.Init</code> combining <code>PTransform</code>.
<p>Call <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html#withPrecision-int-"><code>withPrecision(int)</code></a> to customize the <code>precision</code> parameter of the
sketch.
<p>Call <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html#globally--"><code>globally()</code></a> or <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html#perKey--"><code>perKey()</code></a> to finalize the <code>PTransform</code>.</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="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.Globally.html" title="class in org.apache.beam.sdk.transforms">Combine.Globally</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="type parameter in HllCount.Init.Builder">InputT</a>,byte[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.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;InputT&gt;</code> and returns a <code>PCollection&lt;byte[]&gt;</code> which consists of the HLL++
sketch computed from the elements in the input <code>PCollection</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>&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,<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="type parameter in HllCount.Init.Builder">InputT</a>,byte[]&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.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, InputT&gt;&gt;</code> and returns a <code>PCollection&lt;KV&lt;K, byte[]&gt;&gt;</code> which consists
of the per-key HLL++ sketch computed from the values matching each key in the input <code>PCollection</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="class in org.apache.beam.sdk.extensions.zetasketch">HllCount.Init.Builder</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="type parameter in HllCount.Init.Builder">InputT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html#withPrecision-int-">withPrecision</a></span>(int&nbsp;precision)</code>
<div class="block">Explicitly set the <code>precision</code> parameter used to compute HLL++ sketch.</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="withPrecision-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPrecision</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="class in org.apache.beam.sdk.extensions.zetasketch">HllCount.Init.Builder</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="type parameter in HllCount.Init.Builder">InputT</a>&gt;&nbsp;withPrecision(int&nbsp;precision)</pre>
<div class="block">Explicitly set the <code>precision</code> parameter used to compute HLL++ sketch.
<p>Valid range is between <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.html#MINIMUM_PRECISION"><code>HllCount.MINIMUM_PRECISION</code></a> and <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.html#MAXIMUM_PRECISION"><code>HllCount.MAXIMUM_PRECISION</code></a>. If
this method is not called, <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.html#DEFAULT_PRECISION"><code>HllCount.DEFAULT_PRECISION</code></a> will be used. Sketches computed using
different <code>precision</code>s cannot be merged together.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>precision</code> - the <code>precision</code> parameter used to compute HLL++ sketch</dd>
</dl>
</li>
</ul>
<a name="globally--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>globally</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/Combine.Globally.html" title="class in org.apache.beam.sdk.transforms">Combine.Globally</a>&lt;<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="type parameter in HllCount.Init.Builder">InputT</a>,byte[]&gt;&nbsp;globally()</pre>
<div class="block">Returns a <code>Combine.Globally</code> <code>PTransform</code> that takes an input <code>PCollection&lt;InputT&gt;</code> and returns a <code>PCollection&lt;byte[]&gt;</code> which consists of the HLL++
sketch computed from the elements in the input <code>PCollection</code>.
<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&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,<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" title="type parameter in HllCount.Init.Builder">InputT</a>,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, InputT&gt;&gt;</code> and returns a <code>PCollection&lt;KV&lt;K, byte[]&gt;&gt;</code> which consists
of the per-key HLL++ sketch computed from the values matching each key in the input <code>PCollection</code>.</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.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.MergePartial.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/zetasketch/HllCount.Init.Builder.html" target="_top">Frames</a></li>
<li><a href="HllCount.Init.Builder.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>