| |
| |
| <!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.options.value_provider module — Apache Beam 2.68.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=2388e03a"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.portability package" href="apache_beam.portability.html" /> |
| <link rel="prev" title="apache_beam.options.pipeline_options_validator module" href="apache_beam.options.pipeline_options_validator.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 current"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.options.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.options.pipeline_options.html">apache_beam.options.pipeline_options module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.options.pipeline_options_validator.html">apache_beam.options.pipeline_options_validator module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.options.value_provider module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.value_provider.ValueProvider"><code class="docutils literal notranslate"><span class="pre">ValueProvider</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.value_provider.StaticValueProvider"><code class="docutils literal notranslate"><span class="pre">StaticValueProvider</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.value_provider.RuntimeValueProvider"><code class="docutils literal notranslate"><span class="pre">RuntimeValueProvider</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.value_provider.NestedValueProvider"><code class="docutils literal notranslate"><span class="pre">NestedValueProvider</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.value_provider.check_accessible"><code class="docutils literal notranslate"><span class="pre">check_accessible()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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="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.options.html">apache_beam.options package</a></li> |
| <li class="breadcrumb-item active">apache_beam.options.value_provider module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.options.value_provider.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.options.value_provider"> |
| <span id="apache-beam-options-value-provider-module"></span><h1>apache_beam.options.value_provider module<a class="headerlink" href="#module-apache_beam.options.value_provider" title="Link to this heading"></a></h1> |
| <p>A ValueProvider abstracts the notion of fetching a value that may or |
| may not be currently available.</p> |
| <p>This can be used to parameterize transforms that only read values in at |
| runtime, for example.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.ValueProvider"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.value_provider.</span></span><span class="sig-name descname"><span class="pre">ValueProvider</span></span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#ValueProvider"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.ValueProvider" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Base class that all other ValueProviders must implement.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.ValueProvider.is_accessible"> |
| <span class="sig-name descname"><span class="pre">is_accessible</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#ValueProvider.is_accessible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.ValueProvider.is_accessible" title="Link to this definition"></a></dt> |
| <dd><p>Whether the contents of this ValueProvider is available to routines |
| that run at graph construction time.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.ValueProvider.get"> |
| <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#ValueProvider.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.ValueProvider.get" title="Link to this definition"></a></dt> |
| <dd><p>Return the value wrapped by this ValueProvider.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.StaticValueProvider"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.value_provider.</span></span><span class="sig-name descname"><span class="pre">StaticValueProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#StaticValueProvider"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.StaticValueProvider" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.value_provider.ValueProvider" title="apache_beam.options.value_provider.ValueProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueProvider</span></code></a></p> |
| <p>StaticValueProvider is an implementation of ValueProvider that allows |
| for a static value to be provided.</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>value_type</strong> – Type of the static value</p></li> |
| <li><p><strong>value</strong> – Static value</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.StaticValueProvider.is_accessible"> |
| <span class="sig-name descname"><span class="pre">is_accessible</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#StaticValueProvider.is_accessible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.StaticValueProvider.is_accessible" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.StaticValueProvider.get"> |
| <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#StaticValueProvider.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.StaticValueProvider.get" 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.options.value_provider.RuntimeValueProvider"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.value_provider.</span></span><span class="sig-name descname"><span class="pre">RuntimeValueProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#RuntimeValueProvider"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.RuntimeValueProvider" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.value_provider.ValueProvider" title="apache_beam.options.value_provider.ValueProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueProvider</span></code></a></p> |
| <p>RuntimeValueProvider is an implementation of ValueProvider that |
| allows for a value to be provided at execution time rather than |
| at graph construction time.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.RuntimeValueProvider.runtime_options"> |
| <span class="sig-name descname"><span class="pre">runtime_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apache_beam.options.value_provider.RuntimeValueProvider.runtime_options" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.RuntimeValueProvider.experiments"> |
| <span class="sig-name descname"><span class="pre">experiments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Set" title="(in Python v3.13)"><span class="pre">Set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#apache_beam.options.value_provider.RuntimeValueProvider.experiments" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.RuntimeValueProvider.is_accessible"> |
| <span class="sig-name descname"><span class="pre">is_accessible</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#RuntimeValueProvider.is_accessible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.RuntimeValueProvider.is_accessible" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.RuntimeValueProvider.get_value"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#RuntimeValueProvider.get_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.RuntimeValueProvider.get_value" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.RuntimeValueProvider.get"> |
| <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#RuntimeValueProvider.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.RuntimeValueProvider.get" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.RuntimeValueProvider.set_runtime_options"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_runtime_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_options</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#RuntimeValueProvider.set_runtime_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.RuntimeValueProvider.set_runtime_options" 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.options.value_provider.NestedValueProvider"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.value_provider.</span></span><span class="sig-name descname"><span class="pre">NestedValueProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">translator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#NestedValueProvider"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.NestedValueProvider" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.value_provider.ValueProvider" title="apache_beam.options.value_provider.ValueProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueProvider</span></code></a></p> |
| <p>NestedValueProvider is an implementation of ValueProvider that allows |
| for wrapping another ValueProvider object.</p> |
| <p>Creates a NestedValueProvider that wraps the provided ValueProvider.</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>value</strong> – ValueProvider object to wrap</p></li> |
| <li><p><strong>translator</strong> – function that is applied to the ValueProvider</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Raises<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="apache_beam.error.html#apache_beam.error.RuntimeValueProviderError" title="apache_beam.error.RuntimeValueProviderError"><strong>RuntimeValueProviderError</strong></a> – if any of the provided objects are not |
| accessible.</p> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.NestedValueProvider.is_accessible"> |
| <span class="sig-name descname"><span class="pre">is_accessible</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#NestedValueProvider.is_accessible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.NestedValueProvider.is_accessible" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.value_provider.NestedValueProvider.get"> |
| <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#NestedValueProvider.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.NestedValueProvider.get" 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.options.value_provider.check_accessible"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.options.value_provider.</span></span><span class="sig-name descname"><span class="pre">check_accessible</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value_provider_list</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/value_provider.html#check_accessible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.value_provider.check_accessible" title="Link to this definition"></a></dt> |
| <dd><p>A decorator that checks accessibility of a list of ValueProvider objects.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>value_provider_list</strong> – list of ValueProvider objects</p> |
| </dd> |
| <dt class="field-even">Raises<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="apache_beam.error.html#apache_beam.error.RuntimeValueProviderError" title="apache_beam.error.RuntimeValueProviderError"><strong>RuntimeValueProviderError</strong></a> – if any of the provided objects are not |
| accessible.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.options.pipeline_options_validator.html" class="btn btn-neutral float-left" title="apache_beam.options.pipeline_options_validator module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.portability.html" class="btn btn-neutral float-right" title="apache_beam.portability 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> |
