blob: b0c1d7da1a80a5ffed169c823923c8e72d6d985c [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>StateSpec (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="StateSpec (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/StateKeySpec.html" title="class in org.apache.beam.sdk.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="interface in org.apache.beam.sdk.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/state/StateSpec.html" target="_top">Frames</a></li>
<li><a href="StateSpec.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.state</div>
<h2 title="Interface StateSpec" class="title">Interface StateSpec&lt;StateT extends <a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state">State</a>&gt;</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>StateT</code> - The type of state being described.</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.io.Serializable</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">StateSpec&lt;StateT extends <a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state">State</a>&gt;</span>
extends java.io.Serializable</pre>
<div class="block">A specification of a persistent state cell. This includes information necessary to encode the
value and details about the intended access pattern.</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="interface in org.apache.beam.sdk.state">StateSpec.Cases</a>&lt;<a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="type parameter in StateSpec.Cases">ResultT</a>&gt;</span></code>
<div class="block">Cases for doing a "switch" on the type of <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a>.</div>
</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">&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></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/StateSpec.html" title="type parameter in StateSpec">StateT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html#bind-java.lang.String-org.apache.beam.sdk.state.StateBinder-">bind</a></span>(java.lang.String&nbsp;id,
<a href="../../../../../org/apache/beam/sdk/state/StateBinder.html" title="interface in org.apache.beam.sdk.state">StateBinder</a>&nbsp;binder)</code>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html#finishSpecifying--">finishSpecifying</a></span>()</code>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>&lt;ResultT&gt;&nbsp;ResultT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html#match-org.apache.beam.sdk.state.StateSpec.Cases-">match</a></span>(<a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="interface in org.apache.beam.sdk.state">StateSpec.Cases</a>&lt;ResultT&gt;&nbsp;cases)</code>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html#offerCoders-org.apache.beam.sdk.coders.Coder:A-">offerCoders</a></span>(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>[]&nbsp;coders)</code>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></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="bind-java.lang.String-org.apache.beam.sdk.state.StateBinder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bind</h4>
<pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
<a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="type parameter in StateSpec">StateT</a>&nbsp;bind(java.lang.String&nbsp;id,
<a href="../../../../../org/apache/beam/sdk/state/StateBinder.html" title="interface in org.apache.beam.sdk.state">StateBinder</a>&nbsp;binder)</pre>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b>
<p>Use the <code>binder</code> to create an instance of <code>StateT</code> appropriate for this address.</div>
</li>
</ul>
<a name="match-org.apache.beam.sdk.state.StateSpec.Cases-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>match</h4>
<pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
&lt;ResultT&gt;&nbsp;ResultT&nbsp;match(<a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="interface in org.apache.beam.sdk.state">StateSpec.Cases</a>&lt;ResultT&gt;&nbsp;cases)</pre>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b>
<p>Perform case analysis on this <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> using the provided <a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec.Cases</code></a>.</div>
</li>
</ul>
<a name="offerCoders-org.apache.beam.sdk.coders.Coder:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offerCoders</h4>
<pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
void&nbsp;offerCoders(<a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>[]&nbsp;coders)</pre>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b>
<p>Given {code coders} are inferred from type arguments defined for this class. Coders which
are already set should take precedence over offered coders.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>coders</code> - Array of coders indexed by the type arguments order. Entries might be null if the
coder could not be inferred.</dd>
</dl>
</li>
</ul>
<a name="finishSpecifying--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finishSpecifying</h4>
<pre><a href="../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
void&nbsp;finishSpecifying()</pre>
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b>
<p>Validates that this <a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state"><code>StateSpec</code></a> has been specified correctly and finalizes it.
Automatically invoked when the pipeline is built.</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/StateKeySpec.html" title="class in org.apache.beam.sdk.state"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="interface in org.apache.beam.sdk.state"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/state/StateSpec.html" target="_top">Frames</a></li>
<li><a href="StateSpec.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><a href="#nested.class.summary">Nested</a>&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>