| <!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>ApproximateCountDistinct (Apache Beam 2.47.0)</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="ApproximateCountDistinct (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.Globally.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.html" target="_top">Frames</a></li> |
| <li><a href="ApproximateCountDistinct.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.class.summary">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.sdk.extensions.zetasketch</div> |
| <h2 title="Class ApproximateCountDistinct" class="title">Class ApproximateCountDistinct</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.extensions.zetasketch.ApproximateCountDistinct</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a> |
| public class <span class="typeNameLabel">ApproximateCountDistinct</span> |
| extends java.lang.Object</pre> |
| <div class="block"><code>PTransform</code>s for estimating the number of distinct elements in a <code>PCollection</code>, or |
| the number of distinct values associated with each key in a <code>PCollection</code> of <code>KV</code>s. |
| |
| <p>We make use of the <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><code>HllCount</code></a> implementation for this transform. Please use <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/HllCount.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><code>HllCount</code></a> directly if you need access to the sketches. |
| |
| <p>If the object is not one of <code>Byte[]</code> <code>Integer</code> <code>Double</code> <code>String</code> make |
| use of <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.Globally.html#via-org.apache.beam.sdk.transforms.ProcessFunction-"><code>ApproximateCountDistinct.Globally.via(org.apache.beam.sdk.transforms.ProcessFunction<T, java.lang.Long>)</code></a> or <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.PerKey.html#via-org.apache.beam.sdk.transforms.ProcessFunction-"><code>ApproximateCountDistinct.PerKey.via(org.apache.beam.sdk.transforms.ProcessFunction<org.apache.beam.sdk.values.KV<K, V>, org.apache.beam.sdk.values.KV<K, java.lang.Long>>)</code></a> |
| |
| <h3>Examples</h3> |
| |
| <h4>Example 1: Approximate Count of Ints <code>PCollection<Integer></code> and specify precision</h4> |
| |
| <pre><code> |
| p.apply("Int", Create.of(ints)).apply("IntHLL", ApproximateCountDistinct.globally() |
| .withPercision(PRECISION)); |
| |
| </code></pre> |
| |
| <h4>Example 2: Approximate Count of Key Value <code>PCollection<KV<Integer,Foo>></code></h4> |
| |
| <pre><code> |
| PCollection<KV<Integer, Long>> result = |
| p.apply("Long", Create.of(longs)).apply("LongHLL", ApproximateCountDistinct.perKey()); |
| |
| </code></pre> |
| |
| <h4>Example 3: Approximate Count of Key Value <code>PCollection<KV<Integer,Foo>></code></h4> |
| |
| <pre><code> |
| PCollection<KV<Integer, Foo>> approxResultInteger = |
| p.apply("Int", Create.of(Foo)) |
| .apply("IntHLL", ApproximateCountDistinct.<Integer, KV<Integer, Integer>>perKey() |
| .via(kv -> KV.of(kv.getKey(), (long) kv.getValue().hashCode()))); |
| </code></pre></div> |
| </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"> </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 class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.Globally.html" title="class in org.apache.beam.sdk.extensions.zetasketch">ApproximateCountDistinct.Globally</a><<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.Globally.html" title="type parameter in ApproximateCountDistinct.Globally">T</a>></span></code> |
| <div class="block"><code>PTransform</code> for estimating the number of distinct elements in a <code>PCollection</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.PerKey.html" title="class in org.apache.beam.sdk.extensions.zetasketch">ApproximateCountDistinct.PerKey</a><<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.PerKey.html" title="type parameter in ApproximateCountDistinct.PerKey">K</a>,<a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.PerKey.html" title="type parameter in ApproximateCountDistinct.PerKey">V</a>></span></code> </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"> </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/extensions/zetasketch/ApproximateCountDistinct.html#ApproximateCountDistinct--">ApproximateCountDistinct</a></span>()</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="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>protected static <T> <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><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.html#builderForType-org.apache.beam.sdk.values.TypeDescriptor-">builderForType</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> input)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><T,?,byte[]></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.html#getUdaf-org.apache.beam.sdk.values.TypeDescriptor-">getUdaf</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> input)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.Globally.html" title="class in org.apache.beam.sdk.extensions.zetasketch">ApproximateCountDistinct.Globally</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.html#globally--">globally</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <K,V> <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.PerKey.html" title="class in org.apache.beam.sdk.extensions.zetasketch">ApproximateCountDistinct.PerKey</a><K,V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.html#perKey--">perKey</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="ApproximateCountDistinct--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ApproximateCountDistinct</h4> |
| <pre>public ApproximateCountDistinct()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ 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 <T> <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.Globally.html" title="class in org.apache.beam.sdk.extensions.zetasketch">ApproximateCountDistinct.Globally</a><T> globally()</pre> |
| </li> |
| </ul> |
| <a name="perKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>perKey</h4> |
| <pre>public static <K,V> <a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.PerKey.html" title="class in org.apache.beam.sdk.extensions.zetasketch">ApproximateCountDistinct.PerKey</a><K,V> perKey()</pre> |
| </li> |
| </ul> |
| <a name="getUdaf-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUdaf</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><T,?,byte[]> getUdaf(<a href="../../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> input)</pre> |
| </li> |
| </ul> |
| <a name="builderForType-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>builderForType</h4> |
| <pre>protected static <T> <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><T> builderForType(<a href="../../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><T> input)</pre> |
| </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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.Globally.html" title="class in org.apache.beam.sdk.extensions.zetasketch"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/zetasketch/ApproximateCountDistinct.html" target="_top">Frames</a></li> |
| <li><a href="ApproximateCountDistinct.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.class.summary">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 ======= --> |
| </body> |
| </html> |