| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.transforms.userstate module — Apache Beam 2.68.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=2388e03a"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.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" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <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" aria-label="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="Navigation menu"> |
| <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.dataframe.html">apache_beam.dataframe 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.ml.html">apache_beam.ml 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 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.transforms.html#subpackages">Subpackages</a></li> |
| <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.async_dofn.html">apache_beam.transforms.async_dofn module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combinefn_lifecycle_pipeline.html">apache_beam.transforms.combinefn_lifecycle_pipeline module</a></li> |
| <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.deduplicate.html">apache_beam.transforms.deduplicate 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.enrichment.html">apache_beam.transforms.enrichment module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.environments.html">apache_beam.transforms.environments module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.error_handling.html">apache_beam.transforms.error_handling 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_java.html">apache_beam.transforms.external_java module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_transform_provider.html">apache_beam.transforms.external_transform_provider module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.fully_qualified_named_transform.html">apache_beam.transforms.fully_qualified_named_transform module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.managed.html">apache_beam.transforms.managed module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.periodicsequence.html">apache_beam.transforms.periodicsequence 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.resources.html">apache_beam.transforms.resources 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.sql.html">apache_beam.transforms.sql 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><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.StateSpec"><code class="docutils literal notranslate"><span class="pre">StateSpec</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.ReadModifyWriteStateSpec"><code class="docutils literal notranslate"><span class="pre">ReadModifyWriteStateSpec</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.BagStateSpec"><code class="docutils literal notranslate"><span class="pre">BagStateSpec</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.SetStateSpec"><code class="docutils literal notranslate"><span class="pre">SetStateSpec</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.CombiningValueStateSpec"><code class="docutils literal notranslate"><span class="pre">CombiningValueStateSpec</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.OrderedListStateSpec"><code class="docutils literal notranslate"><span class="pre">OrderedListStateSpec</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.Timer"><code class="docutils literal notranslate"><span class="pre">Timer</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.TimerSpec"><code class="docutils literal notranslate"><span class="pre">TimerSpec</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.on_timer"><code class="docutils literal notranslate"><span class="pre">on_timer()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.get_dofn_specs"><code class="docutils literal notranslate"><span class="pre">get_dofn_specs()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.is_stateful_dofn"><code class="docutils literal notranslate"><span class="pre">is_stateful_dofn()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.validate_stateful_dofn"><code class="docutils literal notranslate"><span class="pre">validate_stateful_dofn()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.BaseTimer"><code class="docutils literal notranslate"><span class="pre">BaseTimer</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.RuntimeTimer"><code class="docutils literal notranslate"><span class="pre">RuntimeTimer</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.RuntimeState"><code class="docutils literal notranslate"><span class="pre">RuntimeState</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.ReadModifyWriteRuntimeState"><code class="docutils literal notranslate"><span class="pre">ReadModifyWriteRuntimeState</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState"><code class="docutils literal notranslate"><span class="pre">AccumulatingRuntimeState</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.BagRuntimeState"><code class="docutils literal notranslate"><span class="pre">BagRuntimeState</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.SetRuntimeState"><code class="docutils literal notranslate"><span class="pre">SetRuntimeState</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.CombiningValueRuntimeState"><code class="docutils literal notranslate"><span class="pre">CombiningValueRuntimeState</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.OrderedListRuntimeState"><code class="docutils literal notranslate"><span class="pre">OrderedListRuntimeState</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.userstate.UserStateContext"><code class="docutils literal notranslate"><span class="pre">UserStateContext</span></code></a></li> |
| </ul> |
| </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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml 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> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="breadcrumb-item active">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"> |
| |
| <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="Link to this heading"></a></h1> |
| <p>User-facing interfaces for the Beam State and Timer APIs.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.StateSpec"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">StateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#StateSpec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.StateSpec" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Specification for a user DoFn state cell.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.StateSpec.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Read.PipelineContext" title="apache_beam.io.iobase.Read.PipelineContext"><span class="pre">PipelineContext</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">StateSpec</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#StateSpec.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.StateSpec.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.ReadModifyWriteStateSpec"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">ReadModifyWriteStateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#ReadModifyWriteStateSpec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.ReadModifyWriteStateSpec" title="Link 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 notranslate"><span class="pre">StateSpec</span></code></a></p> |
| <p>Specification for a user DoFn value state cell. |
| Read more about ReadModifyWriteState (ValueState) here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#valuestate">https://beam.apache.org/documentation/programming-guide/#valuestate</a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.ReadModifyWriteStateSpec.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Read.PipelineContext" title="apache_beam.io.iobase.Read.PipelineContext"><span class="pre">PipelineContext</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">StateSpec</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#ReadModifyWriteStateSpec.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.ReadModifyWriteStateSpec.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.BagStateSpec"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">BagStateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagStateSpec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagStateSpec" title="Link 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 notranslate"><span class="pre">StateSpec</span></code></a></p> |
| <p>Specification for a user DoFn bag state cell. |
| Read more about BagState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#bagstate">https://beam.apache.org/documentation/programming-guide/#bagstate</a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.BagStateSpec.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Read.PipelineContext" title="apache_beam.io.iobase.Read.PipelineContext"><span class="pre">PipelineContext</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">StateSpec</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagStateSpec.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagStateSpec.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.SetStateSpec"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">SetStateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#SetStateSpec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.SetStateSpec" title="Link 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 notranslate"><span class="pre">StateSpec</span></code></a></p> |
| <p>Specification for a user DoFn Set State cell. |
| Read more about SetState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#setstate">https://beam.apache.org/documentation/programming-guide/#setstate</a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.SetStateSpec.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Read.PipelineContext" title="apache_beam.io.iobase.Read.PipelineContext"><span class="pre">PipelineContext</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">StateSpec</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#SetStateSpec.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.SetStateSpec.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.CombiningValueStateSpec"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">CombiningValueStateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">combine_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueStateSpec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueStateSpec" title="Link 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 notranslate"><span class="pre">StateSpec</span></code></a></p> |
| <p>Specification for a user DoFn combining value state cell. |
| Read more about CombiningValueState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#combiningstate">https://beam.apache.org/documentation/programming-guide/#combiningstate</a></p> |
| <p>Initialize the specification for CombiningValue state.</p> |
| <dl class="simple"> |
| <dt>CombiningValueStateSpec(name, combine_fn) -> Coder-inferred combining value</dt><dd><p>state spec.</p> |
| </dd> |
| <dt>CombiningValueStateSpec(name, coder, combine_fn) -> Combining value state</dt><dd><p>spec with coder and combine_fn specified.</p> |
| </dd> |
| </dl> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The name by which the state is identified.</p></li> |
| <li><p><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.</p></li> |
| <li><p><strong>combine_fn</strong> (<code class="docutils literal notranslate"><span class="pre">CombineFn</span></code> or <code class="docutils literal notranslate"><span class="pre">callable</span></code>) – Function specifying how to |
| combine the values passed to state.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.CombiningValueStateSpec.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Read.PipelineContext" title="apache_beam.io.iobase.Read.PipelineContext"><span class="pre">PipelineContext</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">StateSpec</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueStateSpec.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueStateSpec.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.OrderedListStateSpec"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">OrderedListStateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#OrderedListStateSpec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.OrderedListStateSpec" title="Link 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 notranslate"><span class="pre">StateSpec</span></code></a></p> |
| <p>Specification for a user DoFn ordered list state cell. |
| Read more about OrderedListState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#orderliststate">https://beam.apache.org/documentation/programming-guide/#orderliststate</a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.OrderedListStateSpec.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Read.PipelineContext" title="apache_beam.io.iobase.Read.PipelineContext"><span class="pre">PipelineContext</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">StateSpec</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#OrderedListStateSpec.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.OrderedListStateSpec.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">Timer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dynamic_timer_tag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">windows</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clear_bit</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fire_timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hold_timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">paneinfo</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.transforms.userstate.Timer" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p> |
| <p>Create new instance of Timer(user_key, dynamic_timer_tag, windows, clear_bit, fire_timestamp, hold_timestamp, paneinfo)</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer.clear_bit"> |
| <span class="sig-name descname"><span class="pre">clear_bit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></em><a class="headerlink" href="#apache_beam.transforms.userstate.Timer.clear_bit" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 3</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer.dynamic_timer_tag"> |
| <span class="sig-name descname"><span class="pre">dynamic_timer_tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#apache_beam.transforms.userstate.Timer.dynamic_timer_tag" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 1</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer.fire_timestamp"> |
| <span class="sig-name descname"><span class="pre">fire_timestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.transforms.userstate.Timer.fire_timestamp" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 4</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer.hold_timestamp"> |
| <span class="sig-name descname"><span class="pre">hold_timestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.transforms.userstate.Timer.hold_timestamp" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 5</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer.paneinfo"> |
| <span class="sig-name descname"><span class="pre">paneinfo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">PaneInfo</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.transforms.userstate.Timer.paneinfo" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 6</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer.user_key"> |
| <span class="sig-name descname"><span class="pre">user_key</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></em><a class="headerlink" href="#apache_beam.transforms.userstate.Timer.user_key" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 0</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.Timer.windows"> |
| <span class="sig-name descname"><span class="pre">windows</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><span class="pre">windowed_value.BoundedWindow</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apache_beam.transforms.userstate.Timer.windows" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 2</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.TimerSpec"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">TimerSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#TimerSpec"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.TimerSpec" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Specification for a user stateful DoFn timer. |
| Read more about Timers here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#timers">https://beam.apache.org/documentation/programming-guide/#timers</a></p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.TimerSpec.prefix"> |
| <span class="sig-name descname"><span class="pre">prefix</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts-'</span></em><a class="headerlink" href="#apache_beam.transforms.userstate.TimerSpec.prefix" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.TimerSpec.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.Read.PipelineContext" title="apache_beam.io.iobase.Read.PipelineContext"><span class="pre">PipelineContext</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">key_coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">window_coder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.coders.coders.html#apache_beam.coders.coders.Coder" title="apache_beam.coders.coders.Coder"><span class="pre">Coder</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">TimerFamilySpec</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#TimerSpec.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.TimerSpec.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.on_timer"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">on_timer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timer_spec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apache_beam.transforms.userstate.TimerSpec" title="apache_beam.transforms.userstate.TimerSpec"><span class="pre">TimerSpec</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">CallableT</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">CallableT</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#on_timer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.on_timer" title="Link 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 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </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">'timer'</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="w"> </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">'Timer expired!'</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.get_dofn_specs"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">get_dofn_specs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dofn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><span class="pre">DoFn</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.13)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#apache_beam.transforms.userstate.StateSpec" title="apache_beam.transforms.userstate.StateSpec"><span class="pre">StateSpec</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.13)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#apache_beam.transforms.userstate.TimerSpec" title="apache_beam.transforms.userstate.TimerSpec"><span class="pre">TimerSpec</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#get_dofn_specs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.get_dofn_specs" title="Link to this definition"></a></dt> |
| <dd><p>Gets the state and timer specs for a DoFn, if any.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><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.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.is_stateful_dofn"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">is_stateful_dofn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dofn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><span class="pre">DoFn</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#is_stateful_dofn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.is_stateful_dofn" title="Link to this definition"></a></dt> |
| <dd><p>Determines whether a given DoFn is a stateful DoFn.</p> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.validate_stateful_dofn"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">validate_stateful_dofn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dofn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><span class="pre">DoFn</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#validate_stateful_dofn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.validate_stateful_dofn" title="Link to this definition"></a></dt> |
| <dd><p>Validates the proper specification of a stateful DoFn.</p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.BaseTimer"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">BaseTimer</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BaseTimer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BaseTimer" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.BaseTimer.clear"> |
| <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dynamic_timer_tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BaseTimer.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BaseTimer.clear" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.BaseTimer.set"> |
| <span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dynamic_timer_tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BaseTimer.set"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BaseTimer.set" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.RuntimeTimer"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">RuntimeTimer</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeTimer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeTimer" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.BaseTimer" title="apache_beam.transforms.userstate.BaseTimer"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseTimer</span></code></a></p> |
| <p>Timer interface object passed to user code.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.RuntimeTimer.clear"> |
| <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dynamic_timer_tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeTimer.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeTimer.clear" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.RuntimeTimer.set"> |
| <span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dynamic_timer_tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeTimer.set"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeTimer.set" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.RuntimeState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">RuntimeState</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeState" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>State interface object passed to user code.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.RuntimeState.prefetch"> |
| <span class="sig-name descname"><span class="pre">prefetch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeState.prefetch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeState.prefetch" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.RuntimeState.finalize"> |
| <span class="sig-name descname"><span class="pre">finalize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#RuntimeState.finalize"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.RuntimeState.finalize" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.ReadModifyWriteRuntimeState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">ReadModifyWriteRuntimeState</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#ReadModifyWriteRuntimeState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.ReadModifyWriteRuntimeState" title="Link 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 notranslate"><span class="pre">RuntimeState</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.read"> |
| <span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#ReadModifyWriteRuntimeState.read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.read" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.write"> |
| <span class="sig-name descname"><span class="pre">write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#ReadModifyWriteRuntimeState.write"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.write" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.clear"> |
| <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#ReadModifyWriteRuntimeState.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.clear" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.commit"> |
| <span class="sig-name descname"><span class="pre">commit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#ReadModifyWriteRuntimeState.commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.ReadModifyWriteRuntimeState.commit" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.AccumulatingRuntimeState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">AccumulatingRuntimeState</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#AccumulatingRuntimeState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState" title="Link 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 notranslate"><span class="pre">RuntimeState</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.AccumulatingRuntimeState.read"> |
| <span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable" title="(in Python v3.13)"><span class="pre">Iterable</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#AccumulatingRuntimeState.read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState.read" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.AccumulatingRuntimeState.add"> |
| <span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#AccumulatingRuntimeState.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState.add" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.AccumulatingRuntimeState.clear"> |
| <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#AccumulatingRuntimeState.clear"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState.clear" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.AccumulatingRuntimeState.commit"> |
| <span class="sig-name descname"><span class="pre">commit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#AccumulatingRuntimeState.commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState.commit" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.BagRuntimeState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">BagRuntimeState</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#BagRuntimeState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.BagRuntimeState" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState" title="apache_beam.transforms.userstate.AccumulatingRuntimeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccumulatingRuntimeState</span></code></a></p> |
| <p>Bag state interface object passed to user code. |
| Read more about BagState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#bagstate">https://beam.apache.org/documentation/programming-guide/#bagstate</a></p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.SetRuntimeState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">SetRuntimeState</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#SetRuntimeState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.SetRuntimeState" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState" title="apache_beam.transforms.userstate.AccumulatingRuntimeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccumulatingRuntimeState</span></code></a></p> |
| <p>Set state interface object passed to user code. |
| Read more about SetState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#setstate">https://beam.apache.org/documentation/programming-guide/#setstate</a></p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.CombiningValueRuntimeState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">CombiningValueRuntimeState</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#CombiningValueRuntimeState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.CombiningValueRuntimeState" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState" title="apache_beam.transforms.userstate.AccumulatingRuntimeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccumulatingRuntimeState</span></code></a></p> |
| <p>Combining value state interface object passed to user code. |
| Read more about CombiningValueState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#combiningstate">https://beam.apache.org/documentation/programming-guide/#combiningstate</a></p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.OrderedListRuntimeState"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">OrderedListRuntimeState</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#OrderedListRuntimeState"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.OrderedListRuntimeState" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.userstate.AccumulatingRuntimeState" title="apache_beam.transforms.userstate.AccumulatingRuntimeState"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccumulatingRuntimeState</span></code></a></p> |
| <p>Ordered list state interface object passed to user code. |
| Read more about OrderedListState here: |
| <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#orderliststate">https://beam.apache.org/documentation/programming-guide/#orderliststate</a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.OrderedListRuntimeState.read"> |
| <span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable" title="(in Python v3.13)"><span class="pre">Iterable</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#OrderedListRuntimeState.read"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.OrderedListRuntimeState.read" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.OrderedListRuntimeState.add"> |
| <span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#OrderedListRuntimeState.add"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.OrderedListRuntimeState.add" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.OrderedListRuntimeState.read_range"> |
| <span class="sig-name descname"><span class="pre">read_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_time_stamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit_time_stamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable" title="(in Python v3.13)"><span class="pre">Iterable</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#OrderedListRuntimeState.read_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.OrderedListRuntimeState.read_range" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.OrderedListRuntimeState.clear_range"> |
| <span class="sig-name descname"><span class="pre">clear_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">min_time_stamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit_time_stamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#OrderedListRuntimeState.clear_range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.OrderedListRuntimeState.clear_range" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.UserStateContext"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.userstate.</span></span><span class="sig-name descname"><span class="pre">UserStateContext</span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Wrapper allowing user state and timers to be accessed by a DoFnInvoker.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.UserStateContext.get_timer"> |
| <span class="sig-name descname"><span class="pre">get_timer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timer_spec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apache_beam.transforms.userstate.TimerSpec" title="apache_beam.transforms.userstate.TimerSpec"><span class="pre">TimerSpec</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">windowed_value.BoundedWindow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pane</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PaneInfo</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#apache_beam.transforms.userstate.BaseTimer" title="apache_beam.transforms.userstate.BaseTimer"><span class="pre">BaseTimer</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext.get_timer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext.get_timer" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.UserStateContext.get_state"> |
| <span class="sig-name descname"><span class="pre">get_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state_spec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apache_beam.transforms.userstate.StateSpec" title="apache_beam.transforms.userstate.StateSpec"><span class="pre">StateSpec</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">windowed_value.BoundedWindow</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#apache_beam.transforms.userstate.RuntimeState" title="apache_beam.transforms.userstate.RuntimeState"><span class="pre">RuntimeState</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext.get_state"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext.get_state" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.userstate.UserStateContext.commit"> |
| <span class="sig-name descname"><span class="pre">commit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/userstate.html#UserStateContext.commit"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.userstate.UserStateContext.commit" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.transforms.trigger.html" class="btn btn-neutral float-left" title="apache_beam.transforms.trigger module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <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" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
