| <!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>MultimapState (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="MultimapState (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/state/MapState.html" title="interface in org.apache.beam.sdk.state"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/state/OrderedListState.html" title="interface 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/MultimapState.html" target="_top">Frames</a></li> |
| <li><a href="MultimapState.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="Interface MultimapState" class="title">Interface MultimapState<K,V></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>K</code> - the type of keys maintained by this multimap</dd> |
| <dd><code>V</code> - the type of mapped values</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state">State</a></dd> |
| </dl> |
| <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 interface <span class="typeNameLabel">MultimapState<K,V></span> |
| extends <a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state">State</a></pre> |
| <div class="block">A <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state"><code>ReadableState</code></a> cell mapping keys to bags of values. Keys are considered equivalent if |
| their structural values are equivalent, see <a href="../../../../../org/apache/beam/sdk/coders/Coder.html#structuralValue-T-"><code>Coder.structuralValue(T)</code></a> for additional details. |
| |
| <p>Implementations of this form of state are expected to implement multimap operations |
| efficiently as supported by some associated backing key-value store.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Boolean></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#containsKey-K-">containsKey</a></span>(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key)</code> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state"><code>ReadableState</code></a> whose <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> method will return true if |
| this multimap contains the specified key at the point when that <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> call |
| returns.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Iterable<java.util.Map.Entry<<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a>,<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">V</a>>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#entries--">entries</a></span>()</code> |
| <div class="block">Returns an <code>Iterable</code> over all key-value pairs contained in this multimap.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">V</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#get-K-">get</a></span>(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key)</code> |
| <div class="block">A deferred lookup, returns an empty iterable if the item is not found.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Boolean></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#isEmpty--">isEmpty</a></span>()</code> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state"><code>ReadableState</code></a> whose <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> method will return true if |
| this state is empty at the point when that <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> call returns.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#keys--">keys</a></span>()</code> |
| <div class="block">Returns an <code>Iterable</code> over the keys contained in this multimap.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#put-K-V-">put</a></span>(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key, |
| <a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">V</a> value)</code> |
| <div class="block">Associates the specified value with the specified key in this multimap.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#remove-K-">remove</a></span>(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key)</code> |
| <div class="block">Removes all values associated with the key from this multimap.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.state.State"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.sdk.state.<a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state">State</a></h3> |
| <code><a href="../../../../../org/apache/beam/sdk/state/State.html#clear--">clear</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="put-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="put-K-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>void put(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key, |
| <a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">V</a> value)</pre> |
| <div class="block">Associates the specified value with the specified key in this multimap. Existing values |
| associated with the same key will not be removed. |
| |
| <p>Changes will not be reflected in the results returned by previous calls to <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> on the results any of the reading methods(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#get-K-"><code>get(K)</code></a>, <a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#keys--"><code>keys()</code></a>, |
| <a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#entries--"><code>entries()</code></a>).</div> |
| </li> |
| </ul> |
| <a name="get-java.lang.Object-"> |
| <!-- --> |
| </a><a name="get-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">V</a>>> get(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key)</pre> |
| <div class="block">A deferred lookup, returns an empty iterable if the item is not found. |
| |
| <p>A user is encouraged to call <code>get</code> for all relevant keys and call <code>readLater()</code> |
| on the results. |
| |
| <p>When <code>read</code> is called, a particular state implementation is encouraged to perform all |
| pending reads in a single batch.</div> |
| </li> |
| </ul> |
| <a name="remove-java.lang.Object-"> |
| <!-- --> |
| </a><a name="remove-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>void remove(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key)</pre> |
| <div class="block">Removes all values associated with the key from this multimap. This is a no-op if the key is |
| not contained within the multimap. |
| |
| <p>Changes will not be reflected in the results returned by previous calls to <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> on the results of any of the reading methods(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#get-K-"><code>get(K)</code></a>, <a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#keys--"><code>keys()</code></a>, |
| <a href="../../../../../org/apache/beam/sdk/state/MultimapState.html#entries--"><code>entries()</code></a>).</div> |
| </li> |
| </ul> |
| <a name="keys--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keys</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Iterable<<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a>>> keys()</pre> |
| <div class="block">Returns an <code>Iterable</code> over the keys contained in this multimap.</div> |
| </li> |
| </ul> |
| <a name="entries--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entries</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Iterable<java.util.Map.Entry<<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a>,<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">V</a>>>> entries()</pre> |
| <div class="block">Returns an <code>Iterable</code> over all key-value pairs contained in this multimap.</div> |
| </li> |
| </ul> |
| <a name="containsKey-java.lang.Object-"> |
| <!-- --> |
| </a><a name="containsKey-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsKey</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Boolean> containsKey(<a href="../../../../../org/apache/beam/sdk/state/MultimapState.html" title="type parameter in MultimapState">K</a> key)</pre> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state"><code>ReadableState</code></a> whose <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> method will return true if |
| this multimap contains the specified key at the point when that <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> call |
| returns.</div> |
| </li> |
| </ul> |
| <a name="isEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a><java.lang.Boolean> isEmpty()</pre> |
| <div class="block">Returns a <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state"><code>ReadableState</code></a> whose <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> method will return true if |
| this state is empty at the point when that <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a> call returns.</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/MapState.html" title="interface in org.apache.beam.sdk.state"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/sdk/state/OrderedListState.html" title="interface 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/MultimapState.html" target="_top">Frames</a></li> |
| <li><a href="MultimapState.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> |
