Google Git
Sign in
apache / beam-site / refs/heads/revert-643-revert-642-updates_release_2.47.0 / . / pydoc / 2.47.0 / _modules / apache_beam / transforms / userstate.html
blob: 365565977eff719f07b8e1c9b5824c0688c0e4c7 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.transforms.userstate &mdash; Apache Beam 2.47.0 documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.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 class="version">
2.47.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<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"><a class="reference internal" href="../../../apache_beam.transforms.html">apache_beam.transforms package</a></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="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.transforms.userstate</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for apache_beam.transforms.userstate</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;User-facing interfaces for the Beam State and Timer APIs.</span>
<span class="sd">Experimental; no backwards-compatibility guarantees.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="c1"># mypy: disallow-untyped-defs</span>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">import</span> <span class="nn">types</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TYPE_CHECKING</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Iterable</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NamedTuple</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Set</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TypeVar</span>
<span class="kn">from</span> <span class="nn">apache_beam.coders</span> <span class="kn">import</span> <span class="n">Coder</span>
<span class="kn">from</span> <span class="nn">apache_beam.coders</span> <span class="kn">import</span> <span class="n">coders</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability</span> <span class="kn">import</span> <span class="n">common_urns</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability.api</span> <span class="kn">import</span> <span class="n">beam_runner_api_pb2</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.timeutil</span> <span class="kn">import</span> <span class="n">TimeDomain</span>
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">apache_beam.runners.pipeline_context</span> <span class="kn">import</span> <span class="n">PipelineContext</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="kn">import</span> <span class="n">CombineFn</span><span class="p">,</span> <span class="n">DoFn</span>
<span class="kn">from</span> <span class="nn">apache_beam.utils</span> <span class="kn">import</span> <span class="n">windowed_value</span>
<span class="kn">from</span> <span class="nn">apache_beam.utils.timestamp</span> <span class="kn">import</span> <span class="n">Timestamp</span>
<span class="n">CallableT</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">&#39;CallableT&#39;</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="n">Callable</span><span class="p">)</span>
<div class="viewcode-block" id="StateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.StateSpec">[docs]</a><span class="k">class</span> <span class="nc">StateSpec</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Specification for a user DoFn state cell.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">coder</span><span class="p">):</span>
<span class="c1"># type: (str, Coder) -&gt; None</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;name is not a string&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">coder</span><span class="p">,</span> <span class="n">Coder</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;coder is not of type Coder&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">coder</span> <span class="o">=</span> <span class="n">coder</span>
<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; str</span>
<span class="k">return</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">(</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<div class="viewcode-block" id="StateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.StateSpec.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="c1"># type: (PipelineContext) -&gt; beam_runner_api_pb2.StateSpec</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div></div>
<div class="viewcode-block" id="ReadModifyWriteStateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.ReadModifyWriteStateSpec">[docs]</a><span class="k">class</span> <span class="nc">ReadModifyWriteStateSpec</span><span class="p">(</span><span class="n">StateSpec</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Specification for a user DoFn value state cell.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="ReadModifyWriteStateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.ReadModifyWriteStateSpec.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="c1"># type: (PipelineContext) -&gt; beam_runner_api_pb2.StateSpec</span>
<span class="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">StateSpec</span><span class="p">(</span>
<span class="n">read_modify_write_spec</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">ReadModifyWriteStateSpec</span><span class="p">(</span>
<span class="n">coder_id</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">coder</span><span class="p">)),</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">FunctionSpec</span><span class="p">(</span>
<span class="n">urn</span><span class="o">=</span><span class="n">common_urns</span><span class="o">.</span><span class="n">user_state</span><span class="o">.</span><span class="n">BAG</span><span class="o">.</span><span class="n">urn</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="BagStateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.BagStateSpec">[docs]</a><span class="k">class</span> <span class="nc">BagStateSpec</span><span class="p">(</span><span class="n">StateSpec</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Specification for a user DoFn bag state cell.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="BagStateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.BagStateSpec.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="c1"># type: (PipelineContext) -&gt; beam_runner_api_pb2.StateSpec</span>
<span class="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">StateSpec</span><span class="p">(</span>
<span class="n">bag_spec</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">BagStateSpec</span><span class="p">(</span>
<span class="n">element_coder_id</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">coder</span><span class="p">)),</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">FunctionSpec</span><span class="p">(</span>
<span class="n">urn</span><span class="o">=</span><span class="n">common_urns</span><span class="o">.</span><span class="n">user_state</span><span class="o">.</span><span class="n">BAG</span><span class="o">.</span><span class="n">urn</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="SetStateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.SetStateSpec">[docs]</a><span class="k">class</span> <span class="nc">SetStateSpec</span><span class="p">(</span><span class="n">StateSpec</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Specification for a user DoFn Set State cell&quot;&quot;&quot;</span>
<div class="viewcode-block" id="SetStateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.SetStateSpec.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="c1"># type: (PipelineContext) -&gt; beam_runner_api_pb2.StateSpec</span>
<span class="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">StateSpec</span><span class="p">(</span>
<span class="n">set_spec</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">SetStateSpec</span><span class="p">(</span>
<span class="n">element_coder_id</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">coder</span><span class="p">)),</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">FunctionSpec</span><span class="p">(</span>
<span class="n">urn</span><span class="o">=</span><span class="n">common_urns</span><span class="o">.</span><span class="n">user_state</span><span class="o">.</span><span class="n">BAG</span><span class="o">.</span><span class="n">urn</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="CombiningValueStateSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.CombiningValueStateSpec">[docs]</a><span class="k">class</span> <span class="nc">CombiningValueStateSpec</span><span class="p">(</span><span class="n">StateSpec</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Specification for a user DoFn combining value state cell.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">coder</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">combine_fn</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># type: (str, Optional[Coder], Any) -&gt; None</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Initialize the specification for CombiningValue state.</span>
<span class="sd"> CombiningValueStateSpec(name, combine_fn) -&gt; Coder-inferred combining value</span>
<span class="sd"> state spec.</span>
<span class="sd"> CombiningValueStateSpec(name, coder, combine_fn) -&gt; Combining value state</span>
<span class="sd"> spec with coder and combine_fn specified.</span>
<span class="sd"> Args:</span>
<span class="sd"> name (str): The name by which the state is identified.</span>
<span class="sd"> coder (Coder): Coder specifying how to encode the values to be combined.</span>
<span class="sd"> May be inferred.</span>
<span class="sd"> combine_fn (``CombineFn`` or ``callable``): Function specifying how to</span>
<span class="sd"> combine the values passed to state.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Avoid circular import.</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="kn">import</span> <span class="n">CombineFn</span>
<span class="c1"># We want the coder to be optional, but unfortunately it comes</span>
<span class="c1"># before the non-optional combine_fn parameter, which we can&#39;t</span>
<span class="c1"># change for backwards compatibility reasons.</span>
<span class="c1">#</span>
<span class="c1"># Instead, allow it to be omitted (by either passing two arguments</span>
<span class="c1"># or combine_fn by keyword.)</span>
<span class="k">if</span> <span class="n">combine_fn</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">coder</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;combine_fn must be provided&#39;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">coder</span><span class="p">,</span> <span class="n">combine_fn</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">coder</span>
<span class="bp">self</span><span class="o">.</span><span class="n">combine_fn</span> <span class="o">=</span> <span class="n">CombineFn</span><span class="o">.</span><span class="n">maybe_from_callable</span><span class="p">(</span><span class="n">combine_fn</span><span class="p">)</span>
<span class="c1"># The coder here should be for the accumulator type of the given CombineFn.</span>
<span class="k">if</span> <span class="n">coder</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">coder</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">combine_fn</span><span class="o">.</span><span class="n">get_accumulator_coder</span><span class="p">()</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">coder</span><span class="p">)</span>
<div class="viewcode-block" id="CombiningValueStateSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.CombiningValueStateSpec.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="c1"># type: (PipelineContext) -&gt; beam_runner_api_pb2.StateSpec</span>
<span class="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">StateSpec</span><span class="p">(</span>
<span class="n">combining_spec</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">CombiningStateSpec</span><span class="p">(</span>
<span class="n">combine_fn</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">combine_fn</span><span class="o">.</span><span class="n">to_runner_api</span><span class="p">(</span><span class="n">context</span><span class="p">),</span>
<span class="n">accumulator_coder_id</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">coder</span><span class="p">)),</span>
<span class="n">protocol</span><span class="o">=</span><span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">FunctionSpec</span><span class="p">(</span>
<span class="n">urn</span><span class="o">=</span><span class="n">common_urns</span><span class="o">.</span><span class="n">user_state</span><span class="o">.</span><span class="n">BAG</span><span class="o">.</span><span class="n">urn</span><span class="p">))</span></div></div>
<span class="c1"># TODO(BEAM-9562): Update Timer to have of() and clear() APIs.</span>
<span class="n">Timer</span> <span class="o">=</span> <span class="n">NamedTuple</span><span class="p">(</span>
<span class="s1">&#39;Timer&#39;</span><span class="p">,</span>
<span class="p">[</span>
<span class="p">(</span><span class="s1">&#39;user_key&#39;</span><span class="p">,</span> <span class="n">Any</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;dynamic_timer_tag&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;windows&#39;</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">[</span><span class="s1">&#39;windowed_value.BoundedWindow&#39;</span><span class="p">,</span> <span class="o">...</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;clear_bit&#39;</span><span class="p">,</span> <span class="nb">bool</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;fire_timestamp&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="s1">&#39;Timestamp&#39;</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;hold_timestamp&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="s1">&#39;Timestamp&#39;</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;paneinfo&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="s1">&#39;windowed_value.PaneInfo&#39;</span><span class="p">]),</span>
<span class="p">])</span>
<span class="c1"># TODO(BEAM-9562): Plumb through actual key_coder and window_coder.</span>
<div class="viewcode-block" id="TimerSpec"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.TimerSpec">[docs]</a><span class="k">class</span> <span class="nc">TimerSpec</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Specification for a user stateful DoFn timer.&quot;&quot;&quot;</span>
<span class="n">prefix</span> <span class="o">=</span> <span class="s2">&quot;ts-&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">time_domain</span><span class="p">):</span>
<span class="c1"># type: (str, str) -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span> <span class="o">+</span> <span class="n">name</span>
<span class="k">if</span> <span class="n">time_domain</span> <span class="ow">not</span> <span class="ow">in</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="n">TimeDomain</span><span class="o">.</span><span class="n">REAL_TIME</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Unsupported TimeDomain: </span><span class="si">%r</span><span class="s1">.&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">time_domain</span><span class="p">,</span> <span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">time_domain</span> <span class="o">=</span> <span class="n">time_domain</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_attached_callback</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># type: Optional[Callable]</span>
<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; str</span>
<span class="k">return</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">(</span><span class="si">%s</span><span class="s1">)&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<div class="viewcode-block" id="TimerSpec.to_runner_api"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.TimerSpec.to_runner_api">[docs]</a> <span class="k">def</span> <span class="nf">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">key_coder</span><span class="p">,</span> <span class="n">window_coder</span><span class="p">):</span>
<span class="c1"># type: (PipelineContext, Coder, Coder) -&gt; beam_runner_api_pb2.TimerFamilySpec</span>
<span class="k">return</span> <span class="n">beam_runner_api_pb2</span><span class="o">.</span><span class="n">TimerFamilySpec</span><span class="p">(</span>
<span class="n">time_domain</span><span class="o">=</span><span class="n">TimeDomain</span><span class="o">.</span><span class="n">to_runner_api</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time_domain</span><span class="p">),</span>
<span class="n">timer_family_coder_id</span><span class="o">=</span><span class="n">context</span><span class="o">.</span><span class="n">coders</span><span class="o">.</span><span class="n">get_id</span><span class="p">(</span>
<span class="n">coders</span><span class="o">.</span><span class="n">_TimerCoder</span><span class="p">(</span><span class="n">key_coder</span><span class="p">,</span> <span class="n">window_coder</span><span class="p">)))</span></div></div>
<div class="viewcode-block" id="on_timer"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.on_timer">[docs]</a><span class="k">def</span> <span class="nf">on_timer</span><span class="p">(</span><span class="n">timer_spec</span><span class="p">):</span>
<span class="c1"># type: (TimerSpec) -&gt; Callable[[CallableT], CallableT]</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Decorator for timer firing DoFn method.</span>
<span class="sd"> This decorator allows a user to specify an on_timer processing method</span>
<span class="sd"> in a stateful DoFn. Sample usage::</span>
<span class="sd"> class MyDoFn(DoFn):</span>
<span class="sd"> TIMER_SPEC = TimerSpec(&#39;timer&#39;, TimeDomain.WATERMARK)</span>
<span class="sd"> @on_timer(TIMER_SPEC)</span>
<span class="sd"> def my_timer_expiry_callback(self):</span>
<span class="sd"> logging.info(&#39;Timer expired!&#39;)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">timer_spec</span><span class="p">,</span> <span class="n">TimerSpec</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;@on_timer decorator expected TimerSpec.&#39;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_inner</span><span class="p">(</span><span class="n">method</span><span class="p">):</span>
<span class="c1"># type: (CallableT) -&gt; CallableT</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">callable</span><span class="p">(</span><span class="n">method</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;@on_timer decorator expected callable.&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;Multiple on_timer callbacks registered for </span><span class="si">%r</span><span class="s1">.&#39;</span> <span class="o">%</span> <span class="n">timer_spec</span><span class="p">)</span>
<span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span> <span class="o">=</span> <span class="n">method</span>
<span class="k">return</span> <span class="n">method</span>
<span class="k">return</span> <span class="n">_inner</span></div>
<div class="viewcode-block" id="get_dofn_specs"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.get_dofn_specs">[docs]</a><span class="k">def</span> <span class="nf">get_dofn_specs</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span>
<span class="c1"># type: (DoFn) -&gt; Tuple[Set[StateSpec], Set[TimerSpec]]</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets the state and timer specs for a DoFn, if any.</span>
<span class="sd"> Args:</span>
<span class="sd"> dofn (apache_beam.transforms.core.DoFn): The DoFn instance to introspect for</span>
<span class="sd"> timer and state specs.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Avoid circular import.</span>
<span class="kn">from</span> <span class="nn">apache_beam.runners.common</span> <span class="kn">import</span> <span class="n">MethodWrapper</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="kn">import</span> <span class="n">_DoFnParam</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="kn">import</span> <span class="n">_StateDoFnParam</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.core</span> <span class="kn">import</span> <span class="n">_TimerDoFnParam</span>
<span class="n">all_state_specs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="n">all_timer_specs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="c1"># Validate params to process(), start_bundle(), finish_bundle() and to</span>
<span class="c1"># any on_timer callbacks.</span>
<span class="k">for</span> <span class="n">method_name</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="n">types</span><span class="o">.</span><span class="n">MethodType</span><span class="p">):</span>
<span class="k">continue</span>
<span class="n">method</span> <span class="o">=</span> <span class="n">MethodWrapper</span><span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">)</span>
<span class="n">param_ids</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">d</span><span class="o">.</span><span class="n">param_id</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">method</span><span class="o">.</span><span class="n">defaults</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">_DoFnParam</span><span class="p">)</span>
<span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">param_ids</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">param_ids</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;DoFn </span><span class="si">%r</span><span class="s1"> has duplicate </span><span class="si">%s</span><span class="s1"> method parameters: </span><span class="si">%s</span><span class="s1">.&#39;</span> <span class="o">%</span>
<span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span> <span class="n">param_ids</span><span class="p">))</span>
<span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">method</span><span class="o">.</span><span class="n">defaults</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">_StateDoFnParam</span><span class="p">):</span>
<span class="n">all_state_specs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">state_spec</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">_TimerDoFnParam</span><span class="p">):</span>
<span class="n">all_timer_specs</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">d</span><span class="o">.</span><span class="n">timer_spec</span><span class="p">)</span>
<span class="k">return</span> <span class="n">all_state_specs</span><span class="p">,</span> <span class="n">all_timer_specs</span></div>
<div class="viewcode-block" id="is_stateful_dofn"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.is_stateful_dofn">[docs]</a><span class="k">def</span> <span class="nf">is_stateful_dofn</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span>
<span class="c1"># type: (DoFn) -&gt; bool</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Determines whether a given DoFn is a stateful DoFn.&quot;&quot;&quot;</span>
<span class="c1"># A Stateful DoFn is a DoFn that uses user state or timers.</span>
<span class="n">all_state_specs</span><span class="p">,</span> <span class="n">all_timer_specs</span> <span class="o">=</span> <span class="n">get_dofn_specs</span><span class="p">(</span><span class="n">dofn</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">all_state_specs</span> <span class="ow">or</span> <span class="n">all_timer_specs</span><span class="p">)</span></div>
<div class="viewcode-block" id="validate_stateful_dofn"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.validate_stateful_dofn">[docs]</a><span class="k">def</span> <span class="nf">validate_stateful_dofn</span><span class="p">(</span><span class="n">dofn</span><span class="p">):</span>
<span class="c1"># type: (DoFn) -&gt; None</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Validates the proper specification of a stateful DoFn.&quot;&quot;&quot;</span>
<span class="c1"># Get state and timer specs.</span>
<span class="n">all_state_specs</span><span class="p">,</span> <span class="n">all_timer_specs</span> <span class="o">=</span> <span class="n">get_dofn_specs</span><span class="p">(</span><span class="n">dofn</span><span class="p">)</span>
<span class="c1"># Reject DoFns that have multiple state or timer specs with the same name.</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">all_state_specs</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">all_state_specs</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;DoFn </span><span class="si">%r</span><span class="s1"> has multiple StateSpecs with the same name: </span><span class="si">%s</span><span class="s1">.&#39;</span> <span class="o">%</span>
<span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">all_state_specs</span><span class="p">))</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">all_timer_specs</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">all_timer_specs</span><span class="p">)):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">&#39;DoFn </span><span class="si">%r</span><span class="s1"> has multiple TimerSpecs with the same name: </span><span class="si">%s</span><span class="s1">.&#39;</span> <span class="o">%</span>
<span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">all_timer_specs</span><span class="p">))</span>
<span class="c1"># Reject DoFns that use timer specs without corresponding timer callbacks.</span>
<span class="k">for</span> <span class="n">timer_spec</span> <span class="ow">in</span> <span class="n">all_timer_specs</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">((</span>
<span class="s1">&#39;DoFn </span><span class="si">%r</span><span class="s1"> has a TimerSpec without an associated on_timer &#39;</span>
<span class="s1">&#39;callback: </span><span class="si">%s</span><span class="s1">.&#39;</span><span class="p">)</span> <span class="o">%</span> <span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">timer_spec</span><span class="p">))</span>
<span class="n">method_name</span> <span class="o">=</span> <span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span><span class="o">.</span><span class="vm">__name__</span>
<span class="k">if</span> <span class="p">(</span><span class="n">timer_spec</span><span class="o">.</span><span class="n">_attached_callback</span> <span class="o">!=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">dofn</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span>
<span class="kc">None</span><span class="p">)</span><span class="o">.</span><span class="vm">__func__</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">((</span>
<span class="s1">&#39;The on_timer callback for </span><span class="si">%s</span><span class="s1"> is not the specified .</span><span class="si">%s</span><span class="s1"> method &#39;</span>
<span class="s1">&#39;for DoFn </span><span class="si">%r</span><span class="s1"> (perhaps it was overwritten?).&#39;</span><span class="p">)</span> <span class="o">%</span>
<span class="p">(</span><span class="n">timer_spec</span><span class="p">,</span> <span class="n">method_name</span><span class="p">,</span> <span class="n">dofn</span><span class="p">))</span></div>
<div class="viewcode-block" id="BaseTimer"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.BaseTimer">[docs]</a><span class="k">class</span> <span class="nc">BaseTimer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<div class="viewcode-block" id="BaseTimer.clear"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.BaseTimer.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dynamic_timer_tag</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div>
<div class="viewcode-block" id="BaseTimer.set"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.BaseTimer.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">dynamic_timer_tag</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">):</span>
<span class="c1"># type: (Timestamp, str) -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span></div></div>
<span class="n">_TimerTuple</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span><span class="s1">&#39;timer_tuple&#39;</span><span class="p">,</span> <span class="p">(</span><span class="s1">&#39;cleared&#39;</span><span class="p">,</span> <span class="s1">&#39;timestamp&#39;</span><span class="p">))</span>
<div class="viewcode-block" id="RuntimeTimer"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.RuntimeTimer">[docs]</a><span class="k">class</span> <span class="nc">RuntimeTimer</span><span class="p">(</span><span class="n">BaseTimer</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Timer interface object passed to user code.&quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_timer_recordings</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># type: Dict[str, _TimerTuple]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cleared</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_new_timestamp</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># type: Optional[Timestamp]</span>
<div class="viewcode-block" id="RuntimeTimer.clear"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.RuntimeTimer.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dynamic_timer_tag</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">):</span>
<span class="c1"># type: (str) -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_timer_recordings</span><span class="p">[</span><span class="n">dynamic_timer_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">_TimerTuple</span><span class="p">(</span>
<span class="n">cleared</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">timestamp</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div>
<div class="viewcode-block" id="RuntimeTimer.set"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.RuntimeTimer.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">dynamic_timer_tag</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">):</span>
<span class="c1"># type: (Timestamp, str) -&gt; None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_timer_recordings</span><span class="p">[</span><span class="n">dynamic_timer_tag</span><span class="p">]</span> <span class="o">=</span> <span class="n">_TimerTuple</span><span class="p">(</span>
<span class="n">cleared</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">timestamp</span><span class="o">=</span><span class="n">timestamp</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="RuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.RuntimeState">[docs]</a><span class="k">class</span> <span class="nc">RuntimeState</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;State interface object passed to user code.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="RuntimeState.prefetch"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.RuntimeState.prefetch">[docs]</a> <span class="k">def</span> <span class="nf">prefetch</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="c1"># The default implementation here does nothing.</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="RuntimeState.finalize"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.RuntimeState.finalize">[docs]</a> <span class="k">def</span> <span class="nf">finalize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="k">pass</span></div></div>
<div class="viewcode-block" id="ReadModifyWriteRuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.ReadModifyWriteRuntimeState">[docs]</a><span class="k">class</span> <span class="nc">ReadModifyWriteRuntimeState</span><span class="p">(</span><span class="n">RuntimeState</span><span class="p">):</span>
<div class="viewcode-block" id="ReadModifyWriteRuntimeState.read"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.ReadModifyWriteRuntimeState.read">[docs]</a> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; Any</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="ReadModifyWriteRuntimeState.write"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.ReadModifyWriteRuntimeState.write">[docs]</a> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># type: (Any) -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="ReadModifyWriteRuntimeState.clear"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.ReadModifyWriteRuntimeState.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="ReadModifyWriteRuntimeState.commit"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.ReadModifyWriteRuntimeState.commit">[docs]</a> <span class="k">def</span> <span class="nf">commit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="AccumulatingRuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.AccumulatingRuntimeState">[docs]</a><span class="k">class</span> <span class="nc">AccumulatingRuntimeState</span><span class="p">(</span><span class="n">RuntimeState</span><span class="p">):</span>
<div class="viewcode-block" id="AccumulatingRuntimeState.read"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.AccumulatingRuntimeState.read">[docs]</a> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; Iterable[Any]</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="AccumulatingRuntimeState.add"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.AccumulatingRuntimeState.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># type: (Any) -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="AccumulatingRuntimeState.clear"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.AccumulatingRuntimeState.clear">[docs]</a> <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="AccumulatingRuntimeState.commit"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.AccumulatingRuntimeState.commit">[docs]</a> <span class="k">def</span> <span class="nf">commit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="BagRuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.BagRuntimeState">[docs]</a><span class="k">class</span> <span class="nc">BagRuntimeState</span><span class="p">(</span><span class="n">AccumulatingRuntimeState</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Bag state interface object passed to user code.&quot;&quot;&quot;</span></div>
<div class="viewcode-block" id="SetRuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.SetRuntimeState">[docs]</a><span class="k">class</span> <span class="nc">SetRuntimeState</span><span class="p">(</span><span class="n">AccumulatingRuntimeState</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Set state interface object passed to user code.&quot;&quot;&quot;</span></div>
<div class="viewcode-block" id="CombiningValueRuntimeState"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.CombiningValueRuntimeState">[docs]</a><span class="k">class</span> <span class="nc">CombiningValueRuntimeState</span><span class="p">(</span><span class="n">AccumulatingRuntimeState</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Combining value state interface object passed to user code.&quot;&quot;&quot;</span></div>
<div class="viewcode-block" id="UserStateContext"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.UserStateContext">[docs]</a><span class="k">class</span> <span class="nc">UserStateContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Wrapper allowing user state and timers to be accessed by a DoFnInvoker.&quot;&quot;&quot;</span>
<div class="viewcode-block" id="UserStateContext.get_timer"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.UserStateContext.get_timer">[docs]</a> <span class="k">def</span> <span class="nf">get_timer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">timer_spec</span><span class="p">,</span> <span class="c1"># type: TimerSpec</span>
<span class="n">key</span><span class="p">,</span> <span class="c1"># type: Any</span>
<span class="n">window</span><span class="p">,</span> <span class="c1"># type: windowed_value.BoundedWindow</span>
<span class="n">timestamp</span><span class="p">,</span> <span class="c1"># type: Timestamp</span>
<span class="n">pane</span><span class="p">,</span> <span class="c1"># type: windowed_value.PaneInfo</span>
<span class="p">):</span>
<span class="c1"># type: (...) -&gt; BaseTimer</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="UserStateContext.get_state"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.UserStateContext.get_state">[docs]</a> <span class="k">def</span> <span class="nf">get_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">state_spec</span><span class="p">,</span> <span class="c1"># type: StateSpec</span>
<span class="n">key</span><span class="p">,</span> <span class="c1"># type: Any</span>
<span class="n">window</span><span class="p">,</span> <span class="c1"># type: windowed_value.BoundedWindow</span>
<span class="p">):</span>
<span class="c1"># type: (...) -&gt; RuntimeState</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div>
<div class="viewcode-block" id="UserStateContext.commit"><a class="viewcode-back" href="../../../apache_beam.transforms.userstate.html#apache_beam.testing.benchmarks.nexmark.queries.query3.UserStateContext.commit">[docs]</a> <span class="k">def</span> <span class="nf">commit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -&gt; None</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>