| |
| |
| <!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.testing.benchmarks.nexmark.nexmark_util module — Apache Beam 2.67.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=959b4fbe"></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.testing.benchmarks.wordcount package" href="apache_beam.testing.benchmarks.wordcount.html" /> |
| <link rel="prev" title="apache_beam.testing.benchmarks.nexmark.nexmark_perf module" href="apache_beam.testing.benchmarks.nexmark.nexmark_perf.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 current"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.testing.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.testing.benchmarks.html">apache_beam.testing.benchmarks package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.testing.benchmarks.html#subpackages">Subpackages</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.load_tests.html">apache_beam.testing.load_tests package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.testing.html#submodules">Submodules</a></li> |
| </ul> |
| </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="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.testing.html">apache_beam.testing package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.testing.benchmarks.html">apache_beam.testing.benchmarks package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.testing.benchmarks.nexmark.html">apache_beam.testing.benchmarks.nexmark package</a></li> |
| <li class="breadcrumb-item active">apache_beam.testing.benchmarks.nexmark.nexmark_util module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.testing.benchmarks.nexmark.nexmark_util.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.testing.benchmarks.nexmark.nexmark_util"> |
| <span id="apache-beam-testing-benchmarks-nexmark-nexmark-util-module"></span><h1>apache_beam.testing.benchmarks.nexmark.nexmark_util module<a class="headerlink" href="#module-apache_beam.testing.benchmarks.nexmark.nexmark_util" title="Link to this heading"></a></h1> |
| <p>Utilities for the Nexmark suite.</p> |
| <p>The Nexmark suite is a series of queries (streaming pipelines) performed |
| on a simulation of auction events. This util includes:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li><p>A Command class used to terminate the streaming jobs |
| launched in nexmark_launcher.py by the DirectRunner.</p></li> |
| <li><p>A ParseEventFn DoFn to parse events received from PubSub.</p></li> |
| </ul> |
| </div></blockquote> |
| <p>Usage:</p> |
| <dl class="simple"> |
| <dt>To run a process for a certain duration, define in the code:</dt><dd><p>command = Command(process_to_terminate, args) |
| command.run(timeout=duration)</p> |
| </dd> |
| </dl> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.Command"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">Command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmd</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#Command"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.Command" 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.testing.benchmarks.nexmark.nexmark_util.Command.run"> |
| <span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#Command.run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.Command.run" 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.testing.benchmarks.nexmark.nexmark_util.setup_coder"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">setup_coder</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#setup_coder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.setup_coder" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.ParseEventFn"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">ParseEventFn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">unused_args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">unused_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#ParseEventFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.ParseEventFn" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p> |
| <p>Original parser for parsing raw events info into a Python objects.</p> |
| <p>Each event line has the following format:</p> |
| <blockquote> |
| <div><p>person: <id starting with ‘p’>,name,email,credit_card,city, state,timestamp,extra |
| auction: <id starting with ‘a’>,item_name, description,initial_bid, reserve_price,timestamp,expires,seller,category,extra |
| bid: <auction starting with ‘b’>,bidder,price,timestamp,extra</p> |
| </div></blockquote> |
| <p>For example:</p> |
| <blockquote> |
| <div><p>‘p12345,maria,maria@maria.com,1234-5678-9012-3456, sunnyvale,CA,1528098831536’ |
| ‘a12345,car67,2012 hyundai elantra,15000,20000, 1528098831536,20180630,maria,vehicle’ |
| ‘b12345,maria,20000,1528098831536’</p> |
| </div></blockquote> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.ParseEventFn.process"> |
| <span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elem</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#ParseEventFn.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.ParseEventFn.process" 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.testing.benchmarks.nexmark.nexmark_util.ParseJsonEventFn"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">ParseJsonEventFn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">unused_args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">unused_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#ParseJsonEventFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.ParseJsonEventFn" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a></p> |
| <p>Parses the raw event info into a Python objects.</p> |
| <p>Each event line has the following format:</p> |
| <blockquote> |
| <div><p>person: {id,name,email,credit_card,city, state,timestamp,extra} |
| auction: {id,item_name, description,initial_bid, reserve_price,timestamp,expires,seller,category,extra} |
| bid: {auction,bidder,price,timestamp,extra}</p> |
| </div></blockquote> |
| <p>For example:</p> |
| <blockquote> |
| <div><p>{“id”:1000,”name”:”Peter Jones”,”emailAddress”:”<a class="reference external" href="mailto:nhd%40xcat.com">nhd<span>@</span>xcat<span>.</span>com</a>”, “creditCard”:”7241 7320 9143 4888”,”city”:”Portland”,”state”:”WY”, “dateTime”:1528098831026,”extra”:”WN_HS_bnpVQ[[“}</p> |
| <p>{“id”:1000,”itemName”:”wkx mgee”,”description”:”eszpqxtdxrvwmmywkmogoahf”, “initialBid”:28873,”reserve”:29448,”dateTime”:1528098831036, “expires”:1528098840451,”seller”:1000,”category”:13,”extra”:”zcuupiz”}</p> |
| <p>{“auction”:1000,”bidder”:1001,”price”:32530001,”dateTime”:1528098831066, “extra”:”fdiysaV^]NLVsbolvyqwgticfdrwdyiyofWPYTOuwogvszlxjrcNOORM”}</p> |
| </div></blockquote> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.ParseJsonEventFn.process"> |
| <span class="sig-name descname"><span class="pre">process</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elem</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#ParseJsonEventFn.process"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.ParseJsonEventFn.process" 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.testing.benchmarks.nexmark.nexmark_util.CountAndLog"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">CountAndLog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label</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 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/testing/benchmarks/nexmark/nexmark_util.html#CountAndLog"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.CountAndLog" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">PTransform</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.CountAndLog.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcoll</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#CountAndLog.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.CountAndLog.expand" 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.testing.benchmarks.nexmark.nexmark_util.log_count_info"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">log_count_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#log_count_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.log_count_info" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.display"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">display</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elm</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#display"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.display" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.model_to_json"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">model_to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#model_to_json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.model_to_json" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.construct_json_dict"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">construct_json_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#construct_json_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.construct_json_dict" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.unnest_to_json"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">unnest_to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cand</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#unnest_to_json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.unnest_to_json" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.millis_to_timestamp"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">millis_to_timestamp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">millis</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/functions.html#int" title="(in Python v3.13)"><span class="pre">int</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 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></span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#millis_to_timestamp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.millis_to_timestamp" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.get_counter_metric"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">get_counter_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineResult" title="apache_beam.runners.runner.PipelineResult"><span class="pre">PipelineResult</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</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">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><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#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#get_counter_metric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.get_counter_metric" title="Link to this definition"></a></dt> |
| <dd><p>get specific counter metric from pipeline result</p> |
| <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>result</strong> – the PipelineResult which metrics are read from</p></li> |
| <li><p><strong>namespace</strong> – a string representing the namespace of wanted metric</p></li> |
| <li><p><strong>name</strong> – a string representing the name of the wanted metric</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>the result of the wanted metric if it exist, else -1</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.get_start_time_metric"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">get_start_time_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineResult" title="apache_beam.runners.runner.PipelineResult"><span class="pre">PipelineResult</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</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">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><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#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#get_start_time_metric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.get_start_time_metric" title="Link to this definition"></a></dt> |
| <dd><p>get the start time out of all times recorded by the specified distribution |
| metric</p> |
| <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>result</strong> – the PipelineResult which metrics are read from</p></li> |
| <li><p><strong>namespace</strong> – a string representing the namespace of wanted metric</p></li> |
| <li><p><strong>name</strong> – a string representing the name of the wanted metric</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>the smallest time in the metric or -1 if it doesn’t exist</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.testing.benchmarks.nexmark.nexmark_util.get_end_time_metric"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.testing.benchmarks.nexmark.nexmark_util.</span></span><span class="sig-name descname"><span class="pre">get_end_time_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineResult" title="apache_beam.runners.runner.PipelineResult"><span class="pre">PipelineResult</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</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">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><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#int" title="(in Python v3.13)"><span class="pre">int</span></a></span></span><a class="reference internal" href="_modules/apache_beam/testing/benchmarks/nexmark/nexmark_util.html#get_end_time_metric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.testing.benchmarks.nexmark.nexmark_util.get_end_time_metric" title="Link to this definition"></a></dt> |
| <dd><p>get the end time out of all times recorded by the specified distribution |
| metric</p> |
| <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>result</strong> – the PipelineResult which metrics are read from</p></li> |
| <li><p><strong>namespace</strong> – a string representing the namespace of wanted metric</p></li> |
| <li><p><strong>name</strong> – a string representing the name of the wanted metric</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>the largest time in the metric or -1 if it doesn’t exist</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.testing.benchmarks.nexmark.nexmark_perf.html" class="btn btn-neutral float-left" title="apache_beam.testing.benchmarks.nexmark.nexmark_perf module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.testing.benchmarks.wordcount.html" class="btn btn-neutral float-right" title="apache_beam.testing.benchmarks.wordcount package" 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> |
