Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.8.0 / . / javadoc / 2.8.0 / org / apache / beam / sdk / state / package-summary.html
blob: 2362b8037431c329f4ee71e0c54cf8d71193ced0 [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 (1.8.0_161-google-v7) on Thu Oct 18 16:14:38 PDT 2018 -->
<title>org.apache.beam.sdk.state (Apache Beam 2.8.0-SNAPSHOT)</title>
<meta name="date" content="2018-10-18">
<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="org.apache.beam.sdk.state (Apache Beam 2.8.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/schemas/utils/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/beam/sdk/testing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/state/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p>@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.state</h1>
<div class="docSummary">
<div class="block">Classes and interfaces for interacting with state.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/BagState.html" title="interface in org.apache.beam.sdk.state">BagState</a>&lt;T&gt;</td>
<td class="colLast">
<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 containing a bag of values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/CombiningState.html" title="interface in org.apache.beam.sdk.state">CombiningState</a>&lt;InputT,AccumT,OutputT&gt;</td>
<td class="colLast">
<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 defined by a <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>, accepting multiple input values,
combining them as specified into accumulators, and producing a single output value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/GroupingState.html" title="interface in org.apache.beam.sdk.state">GroupingState</a>&lt;InputT,OutputT&gt;</td>
<td class="colLast">
<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 that combines multiple input values and outputs a single value of a
different type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/MapState.html" title="interface in org.apache.beam.sdk.state">MapState</a>&lt;K,V&gt;</td>
<td class="colLast">
<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 values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/ReadableState.html" title="interface in org.apache.beam.sdk.state">ReadableState</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state"><code>State</code></a> that can be read via <a href="../../../../../org/apache/beam/sdk/state/ReadableState.html#read--"><code>ReadableState.read()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/SetState.html" title="interface in org.apache.beam.sdk.state">SetState</a>&lt;T&gt;</td>
<td class="colLast">
<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 containing a set of elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state">State</a></td>
<td class="colLast">
<div class="block">A state cell, supporting a <a href="../../../../../org/apache/beam/sdk/state/State.html#clear--"><code>State.clear()</code></a> operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/StateBinder.html" title="interface in org.apache.beam.sdk.state">StateBinder</a></td>
<td class="colLast">
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/StateContext.html" title="interface in org.apache.beam.sdk.state">StateContext</a>&lt;W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>&gt;</td>
<td class="colLast">
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.html" title="interface in org.apache.beam.sdk.state">StateSpec</a>&lt;StateT extends <a href="../../../../../org/apache/beam/sdk/state/State.html" title="interface in org.apache.beam.sdk.state">State</a>&gt;</td>
<td class="colLast">
<div class="block">A specification of a persistent state cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.html" title="interface in org.apache.beam.sdk.state">StateSpec.Cases</a>&lt;ResultT&gt;</td>
<td class="colLast">
<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>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/Timer.html" title="interface in org.apache.beam.sdk.state">Timer</a></td>
<td class="colLast">
<div class="block">A timer for a specified time domain that can be set to register the desire for further processing
at particular time in its specified time domain.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/Timers.html" title="interface in org.apache.beam.sdk.state">Timers</a></td>
<td class="colLast">
<div class="block">Interface for interacting with time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/TimerSpec.html" title="interface in org.apache.beam.sdk.state">TimerSpec</a></td>
<td class="colLast">
<div class="block">A specification for a <a href="../../../../../org/apache/beam/sdk/state/Timer.html" title="interface in org.apache.beam.sdk.state"><code>Timer</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/ValueState.html" title="interface in org.apache.beam.sdk.state">ValueState</a>&lt;T&gt;</td>
<td class="colLast">
<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 containing a single value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/WatermarkHoldState.html" title="interface in org.apache.beam.sdk.state">WatermarkHoldState</a></td>
<td class="colLast">
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/ReadableStates.html" title="class in org.apache.beam.sdk.state">ReadableStates</a></td>
<td class="colLast">
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/StateContexts.html" title="class in org.apache.beam.sdk.state">StateContexts</a></td>
<td class="colLast">
<div class="block"><b><i>For internal use only; no backwards-compatibility guarantees.</i></b></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/StateSpec.Cases.WithDefault.html" title="class in org.apache.beam.sdk.state">StateSpec.Cases.WithDefault</a>&lt;ResultT&gt;</td>
<td class="colLast">
<div class="block">A base class for a visitor with a default method for cases it is not interested in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/StateSpecs.html" title="class in org.apache.beam.sdk.state">StateSpecs</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/TimerSpecs.html" title="class in org.apache.beam.sdk.state">TimerSpecs</a></td>
<td class="colLast">
<div class="block">Static methods for working with <a href="../../../../../org/apache/beam/sdk/state/TimerSpec.html" title="interface in org.apache.beam.sdk.state"><code>TimerSpecs</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/beam/sdk/state/TimeDomain.html" title="enum in org.apache.beam.sdk.state">TimeDomain</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/beam/sdk/state/TimeDomain.html" title="enum in org.apache.beam.sdk.state"><code>TimeDomain</code></a> specifies whether an operation is based on timestamps of elements or current
"real-world" time as reported while processing.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.state Description">Package org.apache.beam.sdk.state Description</h2>
<div class="block">Classes and interfaces for interacting with state.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/schemas/utils/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/beam/sdk/testing/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/beam/sdk/state/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>