blob: afe6ab39d42f8f6a964efc268201a3896add1dd0 [file] [log] [blame]
<!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.error module &mdash; Apache Beam 2.68.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=2388e03a"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.pipeline module" href="apache_beam.pipeline.html" />
<link rel="prev" title="apache_beam.yaml.yaml_utils module" href="apache_beam.yaml.yaml_utils.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>
<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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">apache_beam.error module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#apache_beam.error.BeamError"><code class="docutils literal notranslate"><span class="pre">BeamError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apache_beam.error.PipelineError"><code class="docutils literal notranslate"><span class="pre">PipelineError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apache_beam.error.PValueError"><code class="docutils literal notranslate"><span class="pre">PValueError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apache_beam.error.RunnerError"><code class="docutils literal notranslate"><span class="pre">RunnerError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apache_beam.error.RuntimeValueProviderError"><code class="docutils literal notranslate"><span class="pre">RuntimeValueProviderError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apache_beam.error.SideInputError"><code class="docutils literal notranslate"><span class="pre">SideInputError</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apache_beam.error.TransformError"><code class="docutils literal notranslate"><span class="pre">TransformError</span></code></a></li>
</ul>
</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 active">apache_beam.error module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.error.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.error">
<span id="apache-beam-error-module"></span><h1>apache_beam.error module<a class="headerlink" href="#module-apache_beam.error" title="Link to this heading"></a></h1>
<p>Python Dataflow error classes.</p>
<dl class="py exception">
<dt class="sig sig-object py" id="apache_beam.error.BeamError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.error.</span></span><span class="sig-name descname"><span class="pre">BeamError</span></span><a class="reference internal" href="_modules/apache_beam/error.html#BeamError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.error.BeamError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
<p>Base class for all Beam errors.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="apache_beam.error.PipelineError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.error.</span></span><span class="sig-name descname"><span class="pre">PipelineError</span></span><a class="reference internal" href="_modules/apache_beam/error.html#PipelineError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.error.PipelineError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.error.BeamError" title="apache_beam.error.BeamError"><code class="xref py py-class docutils literal notranslate"><span class="pre">BeamError</span></code></a></p>
<p>An error in the pipeline object (e.g. a PValue not linked to it).</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="apache_beam.error.PValueError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.error.</span></span><span class="sig-name descname"><span class="pre">PValueError</span></span><a class="reference internal" href="_modules/apache_beam/error.html#PValueError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.error.PValueError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.error.BeamError" title="apache_beam.error.BeamError"><code class="xref py py-class docutils literal notranslate"><span class="pre">BeamError</span></code></a></p>
<p>An error related to a PValue object (e.g. value is not computed).</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="apache_beam.error.RunnerError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.error.</span></span><span class="sig-name descname"><span class="pre">RunnerError</span></span><a class="reference internal" href="_modules/apache_beam/error.html#RunnerError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.error.RunnerError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.error.BeamError" title="apache_beam.error.BeamError"><code class="xref py py-class docutils literal notranslate"><span class="pre">BeamError</span></code></a></p>
<p>An error related to a Runner object (e.g. cannot find a runner to run).</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="apache_beam.error.RuntimeValueProviderError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.error.</span></span><span class="sig-name descname"><span class="pre">RuntimeValueProviderError</span></span><a class="reference internal" href="_modules/apache_beam/error.html#RuntimeValueProviderError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.error.RuntimeValueProviderError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></a></p>
<p>An error related to a ValueProvider object raised during runtime.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="apache_beam.error.SideInputError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.error.</span></span><span class="sig-name descname"><span class="pre">SideInputError</span></span><a class="reference internal" href="_modules/apache_beam/error.html#SideInputError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.error.SideInputError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.error.BeamError" title="apache_beam.error.BeamError"><code class="xref py py-class docutils literal notranslate"><span class="pre">BeamError</span></code></a></p>
<p>An error related to a side input to a parallel Do operation.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="apache_beam.error.TransformError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.error.</span></span><span class="sig-name descname"><span class="pre">TransformError</span></span><a class="reference internal" href="_modules/apache_beam/error.html#TransformError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.error.TransformError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.error.BeamError" title="apache_beam.error.BeamError"><code class="xref py py-class docutils literal notranslate"><span class="pre">BeamError</span></code></a></p>
<p>An error related to a PTransform object.</p>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="apache_beam.yaml.yaml_utils.html" class="btn btn-neutral float-left" title="apache_beam.yaml.yaml_utils module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="apache_beam.pipeline.html" class="btn btn-neutral float-right" title="apache_beam.pipeline module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; 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>