pydoc/2.15.0/apache_beam.transforms.userstate.html - beam-site - Git at Google



 <!DOCTYPE html>
 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 <head>
   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width, initial-scale=1.0">

   <title>apache_beam.transforms.userstate module &mdash; Apache Beam  documentation</title>


     <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />


         <link rel="index" title="Index"
               href="genindex.html"/>
         <link rel="search" title="Search" href="search.html"/>
     <link rel="top" title="Apache Beam  documentation" href="index.html"/>
         <link rel="up" title="apache_beam.transforms package" href="apache_beam.transforms.html"/>
         <link rel="next" title="apache_beam.transforms.util module" href="apache_beam.transforms.util.html"/>
         <link rel="prev" title="apache_beam.transforms.trigger module" href="apache_beam.transforms.trigger.html"/>


   <script src="_static/js/modernizr.min.js"></script>

 </head>

 <body class="wy-body-for-nav" role="document">


   <div class="wy-grid-for-nav">


     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search">


             <a href="index.html" class="icon icon-home"> Apache Beam


           </a>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combiners.html">apache_beam.transforms.combiners module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.core.html">apache_beam.transforms.core module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.create_source.html">apache_beam.transforms.create_source module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.display.html">apache_beam.transforms.display module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external.html">apache_beam.transforms.external module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_test_it.html">apache_beam.transforms.external_test_it module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.ptransform.html">apache_beam.transforms.ptransform module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sideinputs.html">apache_beam.transforms.sideinputs module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.stats.html">apache_beam.transforms.stats module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.timeutil.html">apache_beam.transforms.timeutil module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.trigger.html">apache_beam.transforms.trigger module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.userstate module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.util.html">apache_beam.transforms.util module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.window.html">apache_beam.transforms.window module</a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</a></li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="index.html">Apache Beam</a>

       </nav>


       <div class="wy-nav-content">
         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="index.html">Docs</a> &raquo;</li>

           <li><a href="apache_beam.transforms.html">apache_beam.transforms package</a> &raquo;</li>

       <li>apache_beam.transforms.userstate module</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/apache_beam.transforms.userstate.rst.txt" rel="nofollow"> View page source</a>


       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <div class="section" id="module-apache_beam.transforms.userstate">
 <span id="apache-beam-transforms-userstate-module"></span><h1>apache_beam.transforms.userstate module<a class="headerlink" href="#module-apache_beam.transforms.userstate" title="Permalink to this headline">¶</a></h1>
 <p>User-facing interfaces for the Beam State and Timer APIs.</p>
 <p>Experimental; no backwards-compatibility guarantees.</p>
 <dl class="class">
 <dt id="apache_beam.transforms.userstate.StateSpec">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">StateSpec</code><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#StateSpec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.StateSpec" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></p>
 <p>Specification for a user DoFn state cell.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.StateSpec.to_runner_api">
 <code class="descname">to_runner_api</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#StateSpec.to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.StateSpec.to_runner_api" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.BagStateSpec">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">BagStateSpec</code><span class="sig-paren">(</span><em>name</em>, <em>coder</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagStateSpec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagStateSpec" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.StateSpec" title="apache_beam.transforms.userstate.StateSpec"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.userstate.StateSpec</span></code></a></p>
 <p>Specification for a user DoFn bag state cell.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.BagStateSpec.to_runner_api">
 <code class="descname">to_runner_api</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagStateSpec.to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagStateSpec.to_runner_api" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.CombiningValueStateSpec">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">CombiningValueStateSpec</code><span class="sig-paren">(</span><em>name</em>, <em>coder=None</em>, <em>combine_fn=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueStateSpec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueStateSpec" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.StateSpec" title="apache_beam.transforms.userstate.StateSpec"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.userstate.StateSpec</span></code></a></p>
 <p>Specification for a user DoFn combining value state cell.</p>
 <p>Initialize the specification for CombiningValue state.</p>
 <dl class="docutils">
 <dt>CombiningValueStateSpec(name, combine_fn) -&gt; Coder-inferred combining value</dt>
 <dd>state spec.</dd>
 <dt>CombiningValueStateSpec(name, coder, combine_fn) -&gt; Combining value state</dt>
 <dd>spec with coder and combine_fn specified.</dd>
 </dl>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – The name by which the state is identified.</li>
 <li><strong>coder</strong> (<a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><em>Coder</em></a>) – Coder specifying how to encode the values to be combined.
 May be inferred.</li>
 <li><strong>combine_fn</strong> (<code class="docutils literal"><span class="pre">CombineFn</span></code> or <code class="docutils literal"><span class="pre">callable</span></code>) – Function specifying how to
 combine the values passed to state.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.CombiningValueStateSpec.to_runner_api">
 <code class="descname">to_runner_api</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueStateSpec.to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueStateSpec.to_runner_api" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.TimerSpec">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">TimerSpec</code><span class="sig-paren">(</span><em>name</em>, <em>time_domain</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#TimerSpec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.TimerSpec" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></p>
 <p>Specification for a user stateful DoFn timer.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.TimerSpec.to_runner_api">
 <code class="descname">to_runner_api</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#TimerSpec.to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.TimerSpec.to_runner_api" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.transforms.userstate.on_timer">
 <code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">on_timer</code><span class="sig-paren">(</span><em>timer_spec</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#on_timer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.on_timer" title="Permalink to this definition">¶</a></dt>
 <dd><p>Decorator for timer firing DoFn method.</p>
 <p>This decorator allows a user to specify an on_timer processing method
 in a stateful DoFn.  Sample usage:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyDoFn</span><span class="p">(</span><span class="n">DoFn</span><span class="p">):</span>
   <span class="n">TIMER_SPEC</span> <span class="o">=</span> <span class="n">TimerSpec</span><span class="p">(</span><span class="s1">&#39;timer&#39;</span><span class="p">,</span> <span class="n">TimeDomain</span><span class="o">.</span><span class="n">WATERMARK</span><span class="p">)</span>

   <span class="nd">@on_timer</span><span class="p">(</span><span class="n">TIMER_SPEC</span><span class="p">)</span>
   <span class="k">def</span> <span class="nf">my_timer_expiry_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Timer expired!&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.transforms.userstate.get_dofn_specs">
 <code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">get_dofn_specs</code><span class="sig-paren">(</span><em>dofn</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#get_dofn_specs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.get_dofn_specs" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets the state and timer specs for a DoFn, if any.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dofn</strong> (<a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><em>apache_beam.transforms.core.DoFn</em></a>) – The DoFn instance to introspect for
 timer and state specs.</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.transforms.userstate.is_stateful_dofn">
 <code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">is_stateful_dofn</code><span class="sig-paren">(</span><em>dofn</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#is_stateful_dofn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.is_stateful_dofn" title="Permalink to this definition">¶</a></dt>
 <dd><p>Determines whether a given DoFn is a stateful DoFn.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.transforms.userstate.validate_stateful_dofn">
 <code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">validate_stateful_dofn</code><span class="sig-paren">(</span><em>dofn</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#validate_stateful_dofn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.validate_stateful_dofn" title="Permalink to this definition">¶</a></dt>
 <dd><p>Validates the proper specification of a stateful DoFn.</p>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.RuntimeTimer">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">RuntimeTimer</code><span class="sig-paren">(</span><em>timer_spec</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeTimer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeTimer" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></p>
 <p>Timer interface object passed to user code.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.RuntimeTimer.clear">
 <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeTimer.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeTimer.clear" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.RuntimeTimer.set">
 <code class="descname">set</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeTimer.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeTimer.set" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.RuntimeState">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">RuntimeState</code><span class="sig-paren">(</span><em>state_spec</em>, <em>state_tag</em>, <em>current_value_accessor</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeState" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></p>
 <p>State interface object passed to user code.</p>
 <dl class="staticmethod">
 <dt id="apache_beam.transforms.userstate.RuntimeState.for_spec">
 <em class="property">static </em><code class="descname">for_spec</code><span class="sig-paren">(</span><em>state_spec</em>, <em>state_tag</em>, <em>current_value_accessor</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeState.for_spec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeState.for_spec" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.RuntimeState.prefetch">
 <code class="descname">prefetch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeState.prefetch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeState.prefetch" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.BagRuntimeState">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">BagRuntimeState</code><span class="sig-paren">(</span><em>state_spec</em>, <em>state_tag</em>, <em>current_value_accessor</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagRuntimeState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagRuntimeState" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.RuntimeState" title="apache_beam.transforms.userstate.RuntimeState"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.userstate.RuntimeState</span></code></a></p>
 <p>Bag state interface object passed to user code.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.BagRuntimeState.read">
 <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagRuntimeState.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagRuntimeState.read" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.BagRuntimeState.add">
 <code class="descname">add</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagRuntimeState.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagRuntimeState.add" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.BagRuntimeState.clear">
 <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagRuntimeState.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagRuntimeState.clear" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.CombiningValueRuntimeState">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">CombiningValueRuntimeState</code><span class="sig-paren">(</span><em>state_spec</em>, <em>state_tag</em>, <em>current_value_accessor</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueRuntimeState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueRuntimeState" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.RuntimeState" title="apache_beam.transforms.userstate.RuntimeState"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.userstate.RuntimeState</span></code></a></p>
 <p>Combining value state interface object passed to user code.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.CombiningValueRuntimeState.read">
 <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueRuntimeState.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueRuntimeState.read" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.CombiningValueRuntimeState.add">
 <code class="descname">add</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueRuntimeState.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueRuntimeState.add" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.CombiningValueRuntimeState.clear">
 <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueRuntimeState.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueRuntimeState.clear" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.userstate.UserStateContext">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.userstate.</code><code class="descname">UserStateContext</code><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></p>
 <p>Wrapper allowing user state and timers to be accessed by a DoFnInvoker.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.userstate.UserStateContext.get_timer">
 <code class="descname">get_timer</code><span class="sig-paren">(</span><em>timer_spec</em>, <em>key</em>, <em>window</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext.get_timer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext.get_timer" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.UserStateContext.get_state">
 <code class="descname">get_state</code><span class="sig-paren">(</span><em>state_spec</em>, <em>key</em>, <em>window</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext.get_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext.get_state" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.userstate.UserStateContext.commit">
 <code class="descname">commit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext.commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext.commit" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 </div>


            </div>
            <div class="articleComments">

            </div>
           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="apache_beam.transforms.util.html" class="btn btn-neutral float-right" title="apache_beam.transforms.util module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.transforms.trigger.html" class="btn btn-neutral" title="apache_beam.transforms.trigger module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright .

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
             VERSION:'',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true,
             SOURCELINK_SUFFIX: '.txt'
         };
     </script>
       <script type="text/javascript" src="_static/jquery.js"></script>
       <script type="text/javascript" src="_static/underscore.js"></script>
       <script type="text/javascript" src="_static/doctools.js"></script>


     <script type="text/javascript" src="_static/js/theme.js"></script>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.StickyNav.enable();
       });
   </script>


 </body>
 </html>