blob: fe26080bbf4e5d6e78dc7b6cd7d53b669d1d6d63 [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>StateRequestHandlers.BagUserStateHandlerFactory (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="StateRequestHandlers.BagUserStateHandlerFactory (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":17};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandler.html" title="interface in org.apache.beam.runners.fnexecution.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.IterableSideInputHandler.html" title="interface in org.apache.beam.runners.fnexecution.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" target="_top">Frames</a></li>
<li><a href="StateRequestHandlers.BagUserStateHandlerFactory.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.runners.fnexecution.state</div>
<h2 title="Interface StateRequestHandlers.BagUserStateHandlerFactory" class="title">Interface StateRequestHandlers.BagUserStateHandlerFactory&lt;K,V,W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/beam/runners/fnexecution/state/InMemoryBagUserStateFactory.html" title="class in org.apache.beam.runners.fnexecution.state">InMemoryBagUserStateFactory</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.html" title="class in org.apache.beam.runners.fnexecution.state">StateRequestHandlers</a></dd>
</dl>
<hr>
<br>
<pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/concurrent/ThreadSafe.html?is-external=true" title="class or interface in javax.annotation.concurrent">@ThreadSafe</a>
public static interface <span class="typeNameLabel">StateRequestHandlers.BagUserStateHandlerFactory&lt;K,V,W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;</span></pre>
<div class="block">A factory which constructs <a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandler.html" title="interface in org.apache.beam.runners.fnexecution.state"><code>StateRequestHandlers.BagUserStateHandler</code></a>s.
<p>Note that this factory should be thread safe.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandlers.BagUserStateHandler</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">K</a>,<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">V</a>,<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">W</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html#forUserState-java.lang.String-java.lang.String-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-">forUserState</a></span>(java.lang.String&nbsp;pTransformId,
java.lang.String&nbsp;userStateId,
<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">K</a>&gt;&nbsp;keyCoder,
<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">V</a>&gt;&nbsp;valueCoder,
<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">W</a>&gt;&nbsp;windowCoder)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;K,V,W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;<br><a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandlers.BagUserStateHandlerFactory</a>&lt;K,V,W&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html#unsupported--">unsupported</a></span>()</code>
<div class="block">Throws a <code>UnsupportedOperationException</code> on the first access.</div>
</td>
</tr>
</table>
</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="forUserState-java.lang.String-java.lang.String-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-org.apache.beam.sdk.coders.Coder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forUserState</h4>
<pre><a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandler.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandlers.BagUserStateHandler</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">K</a>,<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">V</a>,<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">W</a>&gt;&nbsp;forUserState(java.lang.String&nbsp;pTransformId,
java.lang.String&nbsp;userStateId,
<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">K</a>&gt;&nbsp;keyCoder,
<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">V</a>&gt;&nbsp;valueCoder,
<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="type parameter in StateRequestHandlers.BagUserStateHandlerFactory">W</a>&gt;&nbsp;windowCoder)</pre>
</li>
</ul>
<a name="unsupported--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unsupported</h4>
<pre>static&nbsp;&lt;K,V,W extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;&nbsp;<a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" title="interface in org.apache.beam.runners.fnexecution.state">StateRequestHandlers.BagUserStateHandlerFactory</a>&lt;K,V,W&gt;&nbsp;unsupported()</pre>
<div class="block">Throws a <code>UnsupportedOperationException</code> on the first access.</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/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandler.html" title="interface in org.apache.beam.runners.fnexecution.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/fnexecution/state/StateRequestHandlers.IterableSideInputHandler.html" title="interface in org.apache.beam.runners.fnexecution.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/state/StateRequestHandlers.BagUserStateHandlerFactory.html" target="_top">Frames</a></li>
<li><a href="StateRequestHandlers.BagUserStateHandlerFactory.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>