| <!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 Mon Jan 27 16:42:31 PST 2020 --> |
| <title>StateSpecs (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="StateSpecs (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":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/state/StateSpec.Cases.WithDefault.html" title="class in org.apache.beam.sdk.state"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/state/TimeDomain.html" title="enum in org.apache.beam.sdk.state"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/state/StateSpecs.html" target="_top">Frames</a></li> |
| <li><a href="StateSpecs.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.state</div> |
| <h2 title="Class StateSpecs" class="title">Class StateSpecs</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.state.StateSpecs</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>(<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#STATE">STATE</a>) |
| public class <span class="typeNameLabel">StateSpecs</span> |
| extends java.lang.Object</pre> |
| <div class="block">Static methods for working with <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpecs</code></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"> </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>static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state">BagState</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#bag--">bag</a></span>()</code> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state"><code>BagState</code></a>, optimized for adding values frequently and |
| occasionally retrieving all the values that have been added.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state">BagState</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#bag-org.apache.beam.sdk.coders.Coder-">bag</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><T> elemCoder)</code> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#bag--"><code>bag()</code></a>, but with an element coder explicitly supplied.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <InputT,AccumT,OutputT><br><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#combining-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.Combine.CombineFn-">combining</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><AccumT> accumCoder, |
| <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combineFn)</code> |
| <div class="block">Identical to <code>#combining(CombineFn)</code>, but with an accumulator coder explicitly supplied.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <InputT,AccumT,OutputT><br><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#combining-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.CombineWithContext.CombineFnWithContext-">combining</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><AccumT> accumCoder, |
| <a href="../../../../../org/apache/beam/sdk/transforms/CombineWithContext.CombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms">CombineWithContext.CombineFnWithContext</a><InputT,AccumT,OutputT> combineFn)</code> |
| <div class="block"><b>For internal use only; no backwards compatibility guarantees</b></div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <InputT,AccumT,OutputT><br><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#combining-org.apache.beam.sdk.transforms.Combine.CombineFn-">combining</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combineFn)</code> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state"><code>CombiningState</code></a> which uses a <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> to |
| automatically merge multiple values of type <code>InputT</code> into a single resulting <code>OutputT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <InputT,AccumT,OutputT><br><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#combining-org.apache.beam.sdk.transforms.CombineWithContext.CombineFnWithContext-">combining</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/CombineWithContext.CombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms">CombineWithContext.CombineFnWithContext</a><InputT,AccumT,OutputT> combineFn)</code> |
| <div class="block"><b>For internal use only; no backwards compatibility guarantees</b></div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <InputT,AccumT,OutputT><br><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#combiningFromInputInternal-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.Combine.CombineFn-">combiningFromInputInternal</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><InputT> inputCoder, |
| <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combineFn)</code> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <InputT,AccumT,OutputT><br><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state">BagState</a><AccumT>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#convertToBagSpecInternal-org.apache.beam.sdk.state.StateSpec-">convertToBagSpecInternal</a></span>(<a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>> combiningSpec)</code> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <K,V> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/MapState.html" title="interface in org.apache.beam.sdk.state">MapState</a><K,V>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#map--">map</a></span>()</code> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state"><code>SetState</code></a>, optimized for key lookups and writes.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <K,V> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/MapState.html" title="interface in org.apache.beam.sdk.state">MapState</a><K,V>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#map-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-">map</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><K> keyCoder, |
| <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><V> valueCoder)</code> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#map--"><code>map()</code></a>, but with key and value coders explicitly supplied.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state">SetState</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#set--">set</a></span>()</code> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state"><code>SetState</code></a>, optimized for checking membership.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state">SetState</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#set-org.apache.beam.sdk.coders.Coder-">set</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><T> elemCoder)</code> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#set--"><code>set()</code></a>, but with an element coder explicitly supplied.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/ValueState.html" title="interface in org.apache.beam.sdk.state">ValueState</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#value--">value</a></span>()</code> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a single value of type <code>T</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/ValueState.html" title="interface in org.apache.beam.sdk.state">ValueState</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#value-org.apache.beam.sdk.coders.Coder-">value</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><T> valueCoder)</code> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#value--"><code>value()</code></a>, but with a coder explicitly supplied.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/WatermarkHoldState.html" title="interface in org.apache.beam.sdk.state">WatermarkHoldState</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#watermarkStateInternal-org.apache.beam.sdk.transforms.windowing.TimestampCombiner-">watermarkStateInternal</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing">TimestampCombiner</a> timestampCombiner)</code> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></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 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="value--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/ValueState.html" title="interface in org.apache.beam.sdk.state">ValueState</a><T>> value()</pre> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a single value of type <code>T</code>. |
| |
| <p>This method attempts to infer the accumulator coder automatically.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#value-org.apache.beam.sdk.coders.Coder-"><code>value(Coder)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="value-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/ValueState.html" title="interface in org.apache.beam.sdk.state">ValueState</a><T>> value(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><T> valueCoder)</pre> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#value--"><code>value()</code></a>, but with a coder explicitly supplied. |
| |
| <p>If automatic coder inference fails, use this method.</div> |
| </li> |
| </ul> |
| <a name="combining-org.apache.beam.sdk.transforms.Combine.CombineFn-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>combining</h4> |
| <pre>public static <InputT,AccumT,OutputT> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>> combining(<a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combineFn)</pre> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state"><code>CombiningState</code></a> which uses a <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> to |
| automatically merge multiple values of type <code>InputT</code> into a single resulting <code>OutputT</code>. |
| |
| <p>This method attempts to infer the accumulator coder automatically.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>#combining(Coder, CombineFn)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="combining-org.apache.beam.sdk.transforms.CombineWithContext.CombineFnWithContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>combining</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public static <InputT,AccumT,OutputT> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>> combining(<a href="../../../../../org/apache/beam/sdk/transforms/CombineWithContext.CombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms">CombineWithContext.CombineFnWithContext</a><InputT,AccumT,OutputT> combineFn)</pre> |
| <div class="block"><b>For internal use only; no backwards compatibility guarantees</b> |
| |
| <p>Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state"><code>CombiningState</code></a> which uses a <a href="../../../../../org/apache/beam/sdk/transforms/CombineWithContext.CombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms"><code>CombineWithContext.CombineFnWithContext</code></a> to automatically merge multiple values of type <code>InputT</code> into a |
| single resulting <code>OutputT</code>. |
| |
| <p>This method attempts to infer the accumulator coder automatically.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>#combining(Coder, CombineFnWithContext)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="combining-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.Combine.CombineFn-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>combining</h4> |
| <pre>public static <InputT,AccumT,OutputT> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>> combining(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><AccumT> accumCoder, |
| <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combineFn)</pre> |
| <div class="block">Identical to <code>#combining(CombineFn)</code>, but with an accumulator coder explicitly supplied. |
| |
| <p>If automatic coder inference fails, use this method.</div> |
| </li> |
| </ul> |
| <a name="combining-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.CombineWithContext.CombineFnWithContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>combining</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public static <InputT,AccumT,OutputT> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>> combining(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><AccumT> accumCoder, |
| <a href="../../../../../org/apache/beam/sdk/transforms/CombineWithContext.CombineFnWithContext.html" title="class in org.apache.beam.sdk.transforms">CombineWithContext.CombineFnWithContext</a><InputT,AccumT,OutputT> combineFn)</pre> |
| <div class="block"><b>For internal use only; no backwards compatibility guarantees</b> |
| |
| <p>Identical to <code>#combining(CombineFnWithContext)</code>, but with an accumulator coder |
| explicitly supplied. |
| |
| <p>If automatic coder inference fails, use this method.</div> |
| </li> |
| </ul> |
| <a name="bag--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bag</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state">BagState</a><T>> bag()</pre> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state"><code>BagState</code></a>, optimized for adding values frequently and |
| occasionally retrieving all the values that have been added. |
| |
| <p>This method attempts to infer the element coder automatically.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#bag-org.apache.beam.sdk.coders.Coder-"><code>bag(Coder)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="bag-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bag</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state">BagState</a><T>> bag(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><T> elemCoder)</pre> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#bag--"><code>bag()</code></a>, but with an element coder explicitly supplied. |
| |
| <p>If automatic coder inference fails, use this method.</div> |
| </li> |
| </ul> |
| <a name="set--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state">SetState</a><T>> set()</pre> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state"><code>SetState</code></a>, optimized for checking membership. |
| |
| <p>This method attempts to infer the element coder automatically.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#set-org.apache.beam.sdk.coders.Coder-"><code>set(Coder)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="set-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public static <T> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state">SetState</a><T>> set(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><T> elemCoder)</pre> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#set--"><code>set()</code></a>, but with an element coder explicitly supplied. |
| |
| <p>If automatic coder inference fails, use this method.</div> |
| </li> |
| </ul> |
| <a name="map--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>map</h4> |
| <pre>public static <K,V> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/MapState.html" title="interface in org.apache.beam.sdk.state">MapState</a><K,V>> map()</pre> |
| <div class="block">Create a <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> for a <a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state"><code>SetState</code></a>, optimized for key lookups and writes. |
| |
| <p>This method attempts to infer the key and value coders automatically.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#map-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-"><code>map(Coder, Coder)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="map-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>map</h4> |
| <pre>public static <K,V> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/MapState.html" title="interface in org.apache.beam.sdk.state">MapState</a><K,V>> map(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><K> keyCoder, |
| <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><V> valueCoder)</pre> |
| <div class="block">Identical to <a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html#map--"><code>map()</code></a>, but with key and value coders explicitly supplied. |
| |
| <p>If automatic coder inference fails, use this method.</div> |
| </li> |
| </ul> |
| <a name="combiningFromInputInternal-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.transforms.Combine.CombineFn-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>combiningFromInputInternal</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public static <InputT,AccumT,OutputT> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>> combiningFromInputInternal(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><InputT> inputCoder, |
| <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combineFn)</pre> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> |
| |
| <p>Create a state spec for values that use a <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> to automatically merge multiple |
| <code>InputT</code>s into a single <code>OutputT</code>. |
| |
| <p>This determines the <code>Coder<AccumT></code> from the given <code>Coder<InputT></code>, and should |
| only be used to initialize static values.</div> |
| </li> |
| </ul> |
| <a name="watermarkStateInternal-org.apache.beam.sdk.transforms.windowing.TimestampCombiner-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>watermarkStateInternal</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public static <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/WatermarkHoldState.html" title="interface in org.apache.beam.sdk.state">WatermarkHoldState</a>> watermarkStateInternal(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing">TimestampCombiner</a> timestampCombiner)</pre> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> |
| |
| <p>Create a state spec for a watermark hold.</div> |
| </li> |
| </ul> |
| <a name="convertToBagSpecInternal-org.apache.beam.sdk.state.StateSpec-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>convertToBagSpecInternal</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a> |
| public static <InputT,AccumT,OutputT> <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state">BagState</a><AccumT>> convertToBagSpecInternal(<a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a><<a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a><InputT,AccumT,OutputT>> combiningSpec)</pre> |
| <div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b> |
| |
| <p>Convert a combining state spec to a bag of accumulators.</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/state/StateSpec.Cases.WithDefault.html" title="class in org.apache.beam.sdk.state"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/state/TimeDomain.html" title="enum in org.apache.beam.sdk.state"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/state/StateSpecs.html" target="_top">Frames</a></li> |
| <li><a href="StateSpecs.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
