| |
| |
| <!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.pipeline_options_validator 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.options.value_provider module" href="apache_beam.options.value_provider.html" /> |
| <link rel="prev" title="apache_beam.options.pipeline_options module" href="apache_beam.options.pipeline_options.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 current"><a class="current reference internal" href="#">apache_beam.options.pipeline_options_validator module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator"><code class="docutils literal notranslate"><span class="pre">PipelineOptionsValidator</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.options.value_provider.html">apache_beam.options.value_provider module</a></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.pipeline_options_validator module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.options.pipeline_options_validator.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.pipeline_options_validator"> |
| <span id="apache-beam-options-pipeline-options-validator-module"></span><h1>apache_beam.options.pipeline_options_validator module<a class="headerlink" href="#module-apache_beam.options.pipeline_options_validator" title="Link to this heading"></a></h1> |
| <p>Pipeline options validator.</p> |
| <p>For internal use only; no backwards-compatibility guarantees.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options_validator.</span></span><span class="sig-name descname"><span class="pre">PipelineOptionsValidator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runner</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator" 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>Validates PipelineOptions.</p> |
| <p>Goes through a list of known PipelineOption subclassess and calls:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">validate</span><span class="p">(</span><span class="n">validator</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>if one is implemented. Aggregates a list of validation errors from all and |
| returns an aggregated list.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.OPTIONS"> |
| <span class="sig-name descname"><span class="pre">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">[<class</span> <span class="pre">'apache_beam.options.pipeline_options.DebugOptions'>,</span> <span class="pre"><class</span> <span class="pre">'apache_beam.options.pipeline_options.GoogleCloudOptions'>,</span> <span class="pre"><class</span> <span class="pre">'apache_beam.options.pipeline_options.PortableOptions'>,</span> <span class="pre"><class</span> <span class="pre">'apache_beam.options.pipeline_options.SetupOptions'>,</span> <span class="pre"><class</span> <span class="pre">'apache_beam.options.pipeline_options.StandardOptions'>,</span> <span class="pre"><class</span> <span class="pre">'apache_beam.options.pipeline_options.TestOptions'>,</span> <span class="pre"><class</span> <span class="pre">'apache_beam.options.pipeline_options.TypeOptions'>,</span> <span class="pre"><class</span> <span class="pre">'apache_beam.options.pipeline_options.WorkerOptions'>]</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.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.pipeline_options_validator.PipelineOptionsValidator.REQUIRED_ENVIRONMENT_OPTIONS"> |
| <span class="sig-name descname"><span class="pre">REQUIRED_ENVIRONMENT_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">{'DOCKER':</span> <span class="pre">[],</span> <span class="pre">'EXTERNAL':</span> <span class="pre">['external_service_address'],</span> <span class="pre">'LOOPBACK':</span> <span class="pre">[],</span> <span class="pre">'PROCESS':</span> <span class="pre">['process_command']}</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.REQUIRED_ENVIRONMENT_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.pipeline_options_validator.PipelineOptionsValidator.OPTIONAL_ENVIRONMENT_OPTIONS"> |
| <span class="sig-name descname"><span class="pre">OPTIONAL_ENVIRONMENT_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">{'DOCKER':</span> <span class="pre">['docker_container_image'],</span> <span class="pre">'EXTERNAL':</span> <span class="pre">[],</span> <span class="pre">'LOOPBACK':</span> <span class="pre">[],</span> <span class="pre">'PROCESS':</span> <span class="pre">['process_variables']}</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.OPTIONAL_ENVIRONMENT_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.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_OPTION"> |
| <span class="sig-name descname"><span class="pre">ERR_MISSING_OPTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Missing</span> <span class="pre">required</span> <span class="pre">option:</span> <span class="pre">%s.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_OPTION" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_GCS_PATH"> |
| <span class="sig-name descname"><span class="pre">ERR_MISSING_GCS_PATH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Missing</span> <span class="pre">GCS</span> <span class="pre">path</span> <span class="pre">option:</span> <span class="pre">%s.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_GCS_PATH" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_PATH"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_GCS_PATH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">GCS</span> <span class="pre">path</span> <span class="pre">(%s),</span> <span class="pre">given</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">option:</span> <span class="pre">%s.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_PATH" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_BUCKET"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_GCS_BUCKET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">GCS</span> <span class="pre">bucket</span> <span class="pre">(%s),</span> <span class="pre">given</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">option:</span> <span class="pre">%s.</span> <span class="pre">See</span> <span class="pre">https://developers.google.com/storage/docs/bucketnaming</span> <span class="pre">for</span> <span class="pre">more</span> <span class="pre">details.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_BUCKET" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_OBJECT"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_GCS_OBJECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">GCS</span> <span class="pre">object</span> <span class="pre">(%s),</span> <span class="pre">given</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">option:</span> <span class="pre">%s.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_OBJECT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_JOB_NAME"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_JOB_NAME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">job_name</span> <span class="pre">(%s);</span> <span class="pre">the</span> <span class="pre">name</span> <span class="pre">must</span> <span class="pre">consist</span> <span class="pre">of</span> <span class="pre">only</span> <span class="pre">the</span> <span class="pre">characters</span> <span class="pre">[-a-z0-9],</span> <span class="pre">starting</span> <span class="pre">with</span> <span class="pre">a</span> <span class="pre">letter</span> <span class="pre">and</span> <span class="pre">ending</span> <span class="pre">with</span> <span class="pre">a</span> <span class="pre">letter</span> <span class="pre">or</span> <span class="pre">number'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_JOB_NAME" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_NUMBER"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_PROJECT_NUMBER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">Project</span> <span class="pre">ID</span> <span class="pre">(%s).</span> <span class="pre">Please</span> <span class="pre">make</span> <span class="pre">sure</span> <span class="pre">you</span> <span class="pre">specified</span> <span class="pre">the</span> <span class="pre">Project</span> <span class="pre">ID,</span> <span class="pre">not</span> <span class="pre">project</span> <span class="pre">number.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_NUMBER" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_ID"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_PROJECT_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">Project</span> <span class="pre">ID</span> <span class="pre">(%s).</span> <span class="pre">Please</span> <span class="pre">make</span> <span class="pre">sure</span> <span class="pre">you</span> <span class="pre">specified</span> <span class="pre">the</span> <span class="pre">Project</span> <span class="pre">ID,</span> <span class="pre">not</span> <span class="pre">project</span> <span class="pre">description.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_ENDPOINT"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_ENDPOINT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">url</span> <span class="pre">(%s)</span> <span class="pre">for</span> <span class="pre">dataflow</span> <span class="pre">endpoint.</span> <span class="pre">Please</span> <span class="pre">provide</span> <span class="pre">a</span> <span class="pre">valid</span> <span class="pre">url.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_ENDPOINT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_NOT_POSITIVE"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_NOT_POSITIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">value</span> <span class="pre">(%s)</span> <span class="pre">for</span> <span class="pre">option:</span> <span class="pre">%s.</span> <span class="pre">Value</span> <span class="pre">needs</span> <span class="pre">to</span> <span class="pre">be</span> <span class="pre">positive.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_NOT_POSITIVE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_TYPE"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_TEST_MATCHER_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">value</span> <span class="pre">(%s)</span> <span class="pre">for</span> <span class="pre">option:</span> <span class="pre">%s.</span> <span class="pre">Please</span> <span class="pre">extend</span> <span class="pre">your</span> <span class="pre">matcher</span> <span class="pre">object</span> <span class="pre">from</span> <span class="pre">hamcrest.core.base_matcher.BaseMatcher.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_UNPICKLABLE"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_TEST_MATCHER_UNPICKLABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">value</span> <span class="pre">(%s)</span> <span class="pre">for</span> <span class="pre">option:</span> <span class="pre">%s.</span> <span class="pre">Please</span> <span class="pre">make</span> <span class="pre">sure</span> <span class="pre">the</span> <span class="pre">test</span> <span class="pre">matcher</span> <span class="pre">is</span> <span class="pre">unpicklable.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_UNPICKLABLE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TRANSFORM_NAME_MAPPING"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_TRANSFORM_NAME_MAPPING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Invalid</span> <span class="pre">transform</span> <span class="pre">name</span> <span class="pre">mapping</span> <span class="pre">format.</span> <span class="pre">Please</span> <span class="pre">make</span> <span class="pre">sure</span> <span class="pre">the</span> <span class="pre">mapping</span> <span class="pre">is</span> <span class="pre">string</span> <span class="pre">key-value</span> <span class="pre">pairs.</span> <span class="pre">Invalid</span> <span class="pre">pair:</span> <span class="pre">(%s:%s)'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TRANSFORM_NAME_MAPPING" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_ENVIRONMENT"> |
| <span class="sig-name descname"><span class="pre">ERR_INVALID_ENVIRONMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Option</span> <span class="pre">%s</span> <span class="pre">is</span> <span class="pre">not</span> <span class="pre">compatible</span> <span class="pre">with</span> <span class="pre">environment</span> <span class="pre">type</span> <span class="pre">%s.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_ENVIRONMENT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_ENVIRONMENT_CONFIG"> |
| <span class="sig-name descname"><span class="pre">ERR_ENVIRONMENT_CONFIG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Option</span> <span class="pre">environment_config</span> <span class="pre">is</span> <span class="pre">incompatible</span> <span class="pre">with</span> <span class="pre">option(s)</span> <span class="pre">%s.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_ENVIRONMENT_CONFIG" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION"> |
| <span class="sig-name descname"><span class="pre">ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Option</span> <span class="pre">%s</span> <span class="pre">is</span> <span class="pre">required</span> <span class="pre">for</span> <span class="pre">environment</span> <span class="pre">type</span> <span class="pre">%s.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_NUM_WORKERS_TOO_HIGH"> |
| <span class="sig-name descname"><span class="pre">ERR_NUM_WORKERS_TOO_HIGH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'num_workers</span> <span class="pre">(%s)</span> <span class="pre">cannot</span> <span class="pre">exceed</span> <span class="pre">max_num_workers</span> <span class="pre">(%s)'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_NUM_WORKERS_TOO_HIGH" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_REPEATABLE_OPTIONS_NOT_SET_AS_LIST"> |
| <span class="sig-name descname"><span class="pre">ERR_REPEATABLE_OPTIONS_NOT_SET_AS_LIST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'(%s)</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">string.</span> <span class="pre">Programmatically</span> <span class="pre">set</span> <span class="pre">PipelineOptions</span> <span class="pre">like</span> <span class="pre">(%s)</span> <span class="pre">options</span> <span class="pre">need</span> <span class="pre">to</span> <span class="pre">be</span> <span class="pre">specified</span> <span class="pre">as</span> <span class="pre">a</span> <span class="pre">list.'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_REPEATABLE_OPTIONS_NOT_SET_AS_LIST" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_URI"> |
| <span class="sig-name descname"><span class="pre">GCS_URI</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'(?P<SCHEME>[^:]+)://(?P<BUCKET>[^/]+)(/(?P<OBJECT>.*))?'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_URI" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_BUCKET"> |
| <span class="sig-name descname"><span class="pre">GCS_BUCKET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'^[a-z0-9][-_a-z0-9.]+[a-z0-9]$'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_BUCKET" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_SCHEME"> |
| <span class="sig-name descname"><span class="pre">GCS_SCHEME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'gs'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_SCHEME" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.JOB_PATTERN"> |
| <span class="sig-name descname"><span class="pre">JOB_PATTERN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'[a-z]([-a-z0-9]*[a-z0-9])?'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.JOB_PATTERN" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_ID_PATTERN"> |
| <span class="sig-name descname"><span class="pre">PROJECT_ID_PATTERN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'[a-z][-a-z0-9:.]+[a-z0-9]'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_ID_PATTERN" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_NUMBER_PATTERN"> |
| <span class="sig-name descname"><span class="pre">PROJECT_NUMBER_PATTERN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'[0-9]*'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_NUMBER_PATTERN" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate"> |
| <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate" title="Link to this definition"></a></dt> |
| <dd><p>Calls validate on subclassess and returns a list of errors.</p> |
| <p>validate will call validate method on subclasses, accumulate the returned |
| list of errors, and returns the aggregate list.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Aggregate list of errors after all calling all possible validate methods.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_service_runner"> |
| <span class="sig-name descname"><span class="pre">is_service_runner</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.is_service_runner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_service_runner" title="Link to this definition"></a></dt> |
| <dd><p>True if pipeline will execute on the Google Cloud Dataflow service.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_full_string_match"> |
| <span class="sig-name descname"><span class="pre">is_full_string_match</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.is_full_string_match"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_full_string_match" title="Link to this definition"></a></dt> |
| <dd><p>Returns True if the pattern matches the whole string.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_gcs_path"> |
| <span class="sig-name descname"><span class="pre">validate_gcs_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_gcs_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_gcs_path" title="Link to this definition"></a></dt> |
| <dd><p>Validates a GCS path against gs://bucket/object URI format.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_cloud_options"> |
| <span class="sig-name descname"><span class="pre">validate_cloud_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_cloud_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_cloud_options" title="Link to this definition"></a></dt> |
| <dd><p>Validates job_name and project arguments.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_sdk_container_image_options"> |
| <span class="sig-name descname"><span class="pre">validate_sdk_container_image_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_sdk_container_image_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_sdk_container_image_options" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_container_prebuilding_options"> |
| <span class="sig-name descname"><span class="pre">validate_container_prebuilding_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_container_prebuilding_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_container_prebuilding_options" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_num_workers"> |
| <span class="sig-name descname"><span class="pre">validate_num_workers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_num_workers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_num_workers" title="Link to this definition"></a></dt> |
| <dd><p>Validates that Dataflow worker number is valid.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_worker_region_zone"> |
| <span class="sig-name descname"><span class="pre">validate_worker_region_zone</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_worker_region_zone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_worker_region_zone" title="Link to this definition"></a></dt> |
| <dd><p>Validates Dataflow worker region and zone arguments are consistent.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_optional_argument_positive"> |
| <span class="sig-name descname"><span class="pre">validate_optional_argument_positive</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_optional_argument_positive"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_optional_argument_positive" title="Link to this definition"></a></dt> |
| <dd><p>Validates that an optional argument (if set) has a positive value.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_test_matcher"> |
| <span class="sig-name descname"><span class="pre">validate_test_matcher</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_test_matcher"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_test_matcher" title="Link to this definition"></a></dt> |
| <dd><p>Validates that on_success_matcher argument if set.</p> |
| <p>Validates that on_success_matcher is unpicklable and is instance |
| of <cite>hamcrest.core.base_matcher.BaseMatcher</cite>.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_environment_options"> |
| <span class="sig-name descname"><span class="pre">validate_environment_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_environment_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_environment_options" title="Link to this definition"></a></dt> |
| <dd><p>Validates portable environment options.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_repeatable_argument_passed_as_list"> |
| <span class="sig-name descname"><span class="pre">validate_repeatable_argument_passed_as_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arg_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_repeatable_argument_passed_as_list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_repeatable_argument_passed_as_list" title="Link to this definition"></a></dt> |
| <dd><p>Validates that repeatable PipelineOptions like dataflow_service_options |
| or experiments are specified as a list when set programmatically. This |
| way, users do not inadvertently specify it as a string, mirroring the way |
| they are set via the command lineRepeatable options, which are as passed a |
| list.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_endpoint_url"> |
| <span class="sig-name descname"><span class="pre">validate_endpoint_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint_url</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_endpoint_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_endpoint_url" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.options.pipeline_options.html" class="btn btn-neutral float-left" title="apache_beam.options.pipeline_options module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.options.value_provider.html" class="btn btn-neutral float-right" title="apache_beam.options.value_provider module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
